Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .devcontainer/setup.sh
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ curl -fsSL https://raw.githubusercontent.com/speakeasy-api/speakeasy/main/instal
rmdir samples || true
mkdir samples

npm install
npm install -g ts-node
npm install --ignore-scripts
npm install -g ts-node --ignore-scripts
npm link
npm link @inkeep/inkeep-analytics
TS_CONFIG_CONTENT=$(cat <<EOL
Expand Down
22 changes: 11 additions & 11 deletions .speakeasy/gen.lock
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,29 @@ id: 63a2136d-3fa3-4a0b-a766-1ddb2460cc12
management:
docChecksum: 70c76a1dc44e466c8e88842bdb15f661
docVersion: 0.1.1
speakeasyVersion: 1.596.0
generationVersion: 2.672.0
releaseVersion: 0.2.4-alpha.33
configChecksum: 4167732c073e3714b1d446f1b22dd972
speakeasyVersion: 1.653.0
generationVersion: 2.748.0
releaseVersion: 0.2.4-alpha.34
configChecksum: 6fdda424264a9e2e3b89e1ee90fbfa86
repoURL: https://github.com/inkeep/inkeep-analytics-typescript.git
installationURL: https://github.com/inkeep/inkeep-analytics-typescript
published: true
features:
typescript:
additionalDependencies: 0.1.0
additionalProperties: 0.1.1
additionalProperties: 0.1.2
constsAndDefaults: 0.1.12
core: 3.21.19
core: 3.26.4
defaultEnabledRetries: 0.1.0
devContainers: 2.90.0
devContainers: 2.90.1
downloadStreams: 0.1.1
enumUnions: 0.1.0
envVarSecurityUsage: 0.1.2
globalSecurity: 2.82.13
globalSecurity: 2.82.14
globalSecurityCallbacks: 0.1.0
globalSecurityFlattening: 0.1.0
globalServerURLs: 2.82.5
groups: 2.81.2
globalServerURLs: 2.83.0
groups: 2.81.3
mcpServer: 0.9.3
methodSecurity: 2.82.6
nameOverrides: 2.81.2
Expand All @@ -34,7 +34,7 @@ features:
responseFormat: 0.2.3
retries: 2.83.0
sdkHooks: 0.3.0
unions: 2.85.11
unions: 2.86.0
generatedFiles:
- .devcontainer/README.md
- .devcontainer/devcontainer.json
Expand Down
14 changes: 13 additions & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,24 @@ generation:
auth:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: true
hoistGlobalSecurity: true
schemas:
allOfMergeStrategy: shallowMerge
requestBodyFieldName: ""
tests:
generateTests: true
generateNewTests: false
skipResponseBodyAssertions: false
typescript:
version: 0.2.4-alpha.33
version: 0.2.4-alpha.34
acceptHeaderEnum: true
additionalDependencies:
dependencies: {}
devDependencies: {}
peerDependencies: {}
additionalPackageJSON: {}
additionalScripts: {}
alwaysIncludeInboundAndOutbound: false
author: Speakeasy
baseErrorName: InkeepAnalyticsError
clientServerStatusCodesAsErrors: true
Expand All @@ -40,6 +47,7 @@ typescript:
enableReactQuery: true
enumFormat: union
envVarPrefix: INKEEPANALYTICS
exportZodModelNamespace: false
flattenGlobalSecurity: true
flatteningOrder: parameters-first
generateExamples: true
Expand All @@ -55,9 +63,13 @@ typescript:
jsonpath: legacy
maxMethodParams: 0
methodArguments: require-security-and-request
modelPropertyCasing: camel
moduleFormat: dual
outputModelSuffix: output
packageName: '@inkeep/inkeep-analytics'
responseFormat: flat
sseFlatResponse: false
templateVersion: v2
usageSDKInitImports: []
useIndexModules: true
zodVersion: v3
6 changes: 3 additions & 3 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
speakeasyVersion: 1.596.0
speakeasyVersion: 1.653.0
sources:
Inkeep Analytics API:
sourceNamespace: inkeep-analytics-api
sourceRevisionDigest: sha256:cfaf97907f52bfd4ac6ecd7130f44c15ca33da9c0d26469e91a9b4152b3ed413
sourceBlobDigest: sha256:55b1b6aa7efa7193719f310504ab7dcf93b41f4368f9603e8c2f169db899f385
tags:
- latest
- speakeasy-sdk-regen-1754325423
- speakeasy-sdk-regen-1754454800
- 0.1.1
targets:
inkeep-analytics:
Expand All @@ -15,7 +15,7 @@ targets:
sourceRevisionDigest: sha256:cfaf97907f52bfd4ac6ecd7130f44c15ca33da9c0d26469e91a9b4152b3ed413
sourceBlobDigest: sha256:55b1b6aa7efa7193719f310504ab7dcf93b41f4368f9603e8c2f169db899f385
codeSamplesNamespace: inkeep-analytics-api-typescript-code-samples
codeSamplesRevisionDigest: sha256:d2445d10c40aef993d8b00b7c86cd3d803093f6838ab4e48483c7fd213459b4b
codeSamplesRevisionDigest: sha256:41405845d0e2e35bd24f0993db8c49d7b9905b0b760b58d311cb9e0817461bf1
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,12 +74,9 @@ bun add @tanstack/react-query react react-dom
### Yarn

```bash
yarn add @inkeep/inkeep-analytics zod
yarn add @inkeep/inkeep-analytics
# Install optional peer dependencies if you plan to use React hooks
yarn add @tanstack/react-query react react-dom

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
```

> [!NOTE]
Expand Down Expand Up @@ -601,7 +598,7 @@ httpClient.addHook("requestError", (error, request) => {
console.groupEnd();
});

const sdk = new InkeepAnalytics({ httpClient });
const sdk = new InkeepAnalytics({ httpClient: httpClient });
```
<!-- End Custom HTTP Client [http-client] -->

Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -378,4 +378,14 @@ Based on:
### Generated
- [typescript v0.2.4-alpha.33] .
### Releases
- [NPM v0.2.4-alpha.33] https://www.npmjs.com/package/@inkeep/inkeep-analytics/v/0.2.4-alpha.33 - .
- [NPM v0.2.4-alpha.33] https://www.npmjs.com/package/@inkeep/inkeep-analytics/v/0.2.4-alpha.33 - .

## 2025-11-11 04:24:54
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.653.0 (2.748.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.2.4-alpha.34] .
### Releases
- [NPM v0.2.4-alpha.34] https://www.npmjs.com/package/@inkeep/inkeep-analytics/v/0.2.4-alpha.34 - .
12 changes: 6 additions & 6 deletions RUNTIMES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:

* [Web Fetch API][web-fetch]
* [Web Streams API][web-streams] and in particular `ReadableStream`
* [Async iterables][async-iter] using `Symbol.asyncIterator`
- [Web Fetch API][web-fetch]
- [Web Streams API][web-streams] and in particular `ReadableStream`
- [Async iterables][async-iter] using `Symbol.asyncIterator`

[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
Expand All @@ -25,7 +25,7 @@ Runtime environments that are explicitly supported are:

The following `tsconfig.json` options are recommended for projects using this
SDK in order to get static type support for features like async iterables,
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
so on):

Expand All @@ -38,11 +38,11 @@ so on):
{
"compilerOptions": {
"target": "es2020", // or higher
"lib": ["es2020", "dom", "dom.iterable"],
"lib": ["es2020", "dom", "dom.iterable"]
}
}
```

While `target` can be set to older ECMAScript versions, it may result in extra,
unnecessary compatibility code being generated if you are not targeting old
runtimes.
runtimes.
2 changes: 1 addition & 1 deletion examples/.env.template
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ INKEEPANALYTICS_API_INTEGRATION_KEY=your_apiintegrationkey_here

# Debug Configuration
# Enable HTTP request/response logging for debugging
INKEEPANALYTICS_DEBUG=false
INKEEPANALYTICS_DEBUG=true
8 changes: 4 additions & 4 deletions examples/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion examples/topSearchQueries.example.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ dotenv.config();
* Example usage of the @inkeep/inkeep-analytics SDK
*
* To run this example from the examples directory:
* npm run build && npx tsx topSearchQueries.ts
* npm run build && npx tsx topSearchQueries.example.ts
*/

import { InkeepAnalytics } from "@inkeep/inkeep-analytics";
Expand Down
2 changes: 1 addition & 1 deletion jsr.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

{
"name": "@inkeep/inkeep-analytics",
"version": "0.2.4-alpha.33",
"version": "0.2.4-alpha.34",
"exports": {
".": "./src/index.ts",
"./models/errors": "./src/models/errors/index.ts",
Expand Down
Loading