@openmeshtak/sdk 0.0.0-stage → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,6 @@
1
+ /**
2
+ * This file was auto-generated by openapi-typescript.
3
+ * Do not make direct changes to the file.
4
+ */
5
+ export {};
6
+ //# sourceMappingURL=schema.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/generated/schema.ts"],"names":[],"mappings":"AAAA;;;GAGG"}
@@ -0,0 +1,2 @@
1
+ export type { components, operations, paths } from "./generated/schema.js";
2
+ //# sourceMappingURL=generated.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"generated.d.ts","sourceRoot":"","sources":["../src/generated.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,UAAU,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"generated.js","sourceRoot":"","sources":["../src/generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,6 @@
1
+ export { createOpenMeshTakClient, OpenMeshTakClient, type ApiKeyProvider, type OpenMeshTakClientOptions, } from "./client.js";
2
+ export { OpenMeshTakApiError, type ProblemDetails } from "./errors.js";
3
+ export { paginate, type Page } from "./pagination.js";
4
+ export type * from "./types.js";
5
+ export { OPENAPI_SOURCE_VERSION, SDK_VERSION, SUPPORTED_API_VERSION_RANGE } from "./version.js";
6
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,iBAAiB,EACjB,KAAK,cAAc,EACnB,KAAK,wBAAwB,GAC9B,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,mBAAmB,EAAE,KAAK,cAAc,EAAE,MAAM,aAAa,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,KAAK,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACtD,mBAAmB,YAAY,CAAC;AAChC,OAAO,EAAE,sBAAsB,EAAE,WAAW,EAAE,2BAA2B,EAAE,MAAM,cAAc,CAAC"}
package/dist/index.js ADDED
@@ -0,0 +1,5 @@
1
+ export { createOpenMeshTakClient, OpenMeshTakClient, } from "./client.js";
2
+ export { OpenMeshTakApiError } from "./errors.js";
3
+ export { paginate } from "./pagination.js";
4
+ export { OPENAPI_SOURCE_VERSION, SDK_VERSION, SUPPORTED_API_VERSION_RANGE } from "./version.js";
5
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,iBAAiB,GAGlB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,mBAAmB,EAAuB,MAAM,aAAa,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAa,MAAM,iBAAiB,CAAC;AAEtD,OAAO,EAAE,sBAAsB,EAAE,WAAW,EAAE,2BAA2B,EAAE,MAAM,cAAc,CAAC"}
@@ -0,0 +1,15 @@
1
+ import type { PageInfo, PageRequest } from "./types.js";
2
+ /** Any OpenMeshTak list response. */
3
+ export interface Page<T> {
4
+ items: T[];
5
+ page: PageInfo;
6
+ }
7
+ /**
8
+ * Yields every item of a list, fetching the next page only when the previous one is used up.
9
+ *
10
+ * ```ts
11
+ * for await (const member of paginate((page) => client.listEventMembers(eventId, page))) { ... }
12
+ * ```
13
+ */
14
+ export declare function paginate<T>(fetchPage: (page: PageRequest) => Promise<Page<T>>): AsyncGenerator<T, void, undefined>;
15
+ //# sourceMappingURL=pagination.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"pagination.d.ts","sourceRoot":"","sources":["../src/pagination.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAExD,qCAAqC;AACrC,MAAM,WAAW,IAAI,CAAC,CAAC;IACrB,KAAK,EAAE,CAAC,EAAE,CAAC;IACX,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED;;;;;;GAMG;AACH,wBAAuB,QAAQ,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,CAYzH"}
@@ -0,0 +1,20 @@
1
+ /**
2
+ * Yields every item of a list, fetching the next page only when the previous one is used up.
3
+ *
4
+ * ```ts
5
+ * for await (const member of paginate((page) => client.listEventMembers(eventId, page))) { ... }
6
+ * ```
7
+ */
8
+ export async function* paginate(fetchPage) {
9
+ let page = {};
10
+ for (;;) {
11
+ const result = await fetchPage(page);
12
+ yield* result.items;
13
+ const nextCursor = result.page.nextCursor;
14
+ if (!result.page.hasMore || nextCursor === null || nextCursor === undefined) {
15
+ return;
16
+ }
17
+ page = { cursor: nextCursor };
18
+ }
19
+ }
20
+ //# sourceMappingURL=pagination.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"pagination.js","sourceRoot":"","sources":["../src/pagination.ts"],"names":[],"mappings":"AAQA;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC,QAAQ,CAAI,SAAkD;IACnF,IAAI,IAAI,GAAgB,EAAE,CAAC;IAC3B,SAAS,CAAC;QACR,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,CAAC;QACrC,KAAK,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;QAEpB,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;QAC1C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,UAAU,KAAK,IAAI,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC5E,OAAO;QACT,CAAC;QACD,IAAI,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;IAChC,CAAC;AACH,CAAC"}
@@ -0,0 +1,46 @@
1
+ {
2
+ "bomFormat": "CycloneDX",
3
+ "specVersion": "1.6",
4
+ "serialNumber": "urn:uuid:d0ca153b-c677-47ac-8063-af22a5ce12e5",
5
+ "version": 1,
6
+ "metadata": {
7
+ "timestamp": "2026-10-08T09:57:51.318Z",
8
+ "component": {
9
+ "type": "library",
10
+ "name": "@openmeshtak/sdk",
11
+ "version": "0.2.1",
12
+ "licenses": [
13
+ {
14
+ "license": {
15
+ "id": "Apache-2.0"
16
+ }
17
+ }
18
+ ],
19
+ "purl": "pkg:npm/%40openmeshtak/sdk@0.2.1"
20
+ }
21
+ },
22
+ "components": [
23
+ {
24
+ "type": "library",
25
+ "name": "openapi-fetch",
26
+ "version": "0.17.0",
27
+ "licenses": [
28
+ {
29
+ "expression": "MIT"
30
+ }
31
+ ],
32
+ "purl": "pkg:npm/openapi-fetch@0.17.0"
33
+ },
34
+ {
35
+ "type": "library",
36
+ "name": "openapi-typescript-helpers",
37
+ "version": "0.1.0",
38
+ "licenses": [
39
+ {
40
+ "expression": "MIT"
41
+ }
42
+ ],
43
+ "purl": "pkg:npm/openapi-typescript-helpers@0.1.0"
44
+ }
45
+ ]
46
+ }
@@ -0,0 +1,48 @@
1
+ import type { components, paths } from "./generated/schema.js";
2
+ type Schemas = components["schemas"];
3
+ /** Cursor of the page to fetch; omit it for the first page. Cursors are opaque. */
4
+ export interface PageRequest {
5
+ cursor?: string;
6
+ }
7
+ /** Page size and cursor accepted by every list operation. */
8
+ export interface PageOptions extends PageRequest {
9
+ /** 1 to 100. */
10
+ limit?: number;
11
+ }
12
+ export type ListEventsOptions = NonNullable<paths["/events"]["get"]["parameters"]["query"]>;
13
+ export type ListSyncIssuesOptions = NonNullable<paths["/events/{eventId}/sync-issues"]["get"]["parameters"]["query"]>;
14
+ export type ExternalProvider = paths["/events/{eventId}/external-members/{provider}/{externalId}"]["put"]["parameters"]["path"]["provider"];
15
+ export type PageInfo = Schemas["PageInfo"];
16
+ export type Principal = Schemas["PrincipalDto"];
17
+ export type Event = Schemas["EventDto"];
18
+ export type EventPage = Schemas["EventPage"];
19
+ export type CreateEventRequest = Schemas["CreateEventRequest"];
20
+ export type UpdateEventRequest = Schemas["UpdateEventRequest"];
21
+ export type EventTransitionRequest = Schemas["EventTransitionRequest"];
22
+ export type EventRole = Schemas["EventRoleDto"];
23
+ export type EventRolePage = Schemas["EventRolePage"];
24
+ export type CreateEventRoleRequest = Schemas["CreateEventRoleRequest"];
25
+ export type UpdateEventRoleRequest = Schemas["UpdateEventRoleRequest"];
26
+ export type EventGroup = Schemas["EventGroupDto"];
27
+ export type EventGroupPage = Schemas["EventGroupPage"];
28
+ export type CreateEventGroupRequest = Schemas["CreateEventGroupRequest"];
29
+ export type UpdateEventGroupRequest = Schemas["UpdateEventGroupRequest"];
30
+ export type EventMember = Schemas["EventMemberDto"];
31
+ export type EventMemberPage = Schemas["EventMemberPage"];
32
+ export type CreateEventMemberRequest = Schemas["CreateEventMemberRequest"];
33
+ export type UpdateEventMemberRequest = Schemas["UpdateEventMemberRequest"];
34
+ export type CreateEventMemberAccountRequest = Schemas["CreateEventMemberAccountRequest"];
35
+ export type CreatedEventMemberAccount = Schemas["CreatedEventMemberAccountResponse"];
36
+ export type ExternalMemberSyncRequest = Schemas["ExternalMemberSyncRequest"];
37
+ export type ExternalMemberSyncResult = Schemas["ExternalMemberSyncResult"];
38
+ export type SyncIssue = Schemas["SyncIssueDto"];
39
+ export type SyncIssuePage = Schemas["SyncIssuePage"];
40
+ export type RetrySyncIssueRequest = Schemas["RetrySyncIssueRequest"];
41
+ export type MemberClaim = Schemas["MemberClaimDto"];
42
+ export type CreatedMemberClaim = Schemas["CreatedMemberClaimResponse"];
43
+ export type ResolvedProfile = Schemas["ResolvedProfileDto"];
44
+ export type ConfigurationRevision = Schemas["ConfigurationRevisionDto"];
45
+ export type ConfigurationRevisionPage = Schemas["ConfigurationRevisionPage"];
46
+ export type PublishConfigurationResult = Schemas["PublishConfigurationResponse"];
47
+ export {};
48
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAE/D,KAAK,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC;AAErC,mFAAmF;AACnF,MAAM,WAAW,WAAW;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,6DAA6D;AAC7D,MAAM,WAAW,WAAY,SAAQ,WAAW;IAC9C,gBAAgB;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,iBAAiB,GAAG,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;AAC5F,MAAM,MAAM,qBAAqB,GAAG,WAAW,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;AACtH,MAAM,MAAM,gBAAgB,GAC1B,KAAK,CAAC,4DAA4D,CAAC,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,CAAC;AAE/G,MAAM,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AAC3C,MAAM,MAAM,SAAS,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;AAEhD,MAAM,MAAM,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AACxC,MAAM,MAAM,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;AAC7C,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAC/D,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAC/D,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;AAEvE,MAAM,MAAM,SAAS,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;AAChD,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;AACrD,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;AACvE,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;AAEvE,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;AAClD,MAAM,MAAM,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;AACvD,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC;AACzE,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC;AAEzE,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;AACpD,MAAM,MAAM,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AACzD,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC;AAC3E,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC;AAC3E,MAAM,MAAM,+BAA+B,GAAG,OAAO,CAAC,iCAAiC,CAAC,CAAC;AACzF,MAAM,MAAM,yBAAyB,GAAG,OAAO,CAAC,mCAAmC,CAAC,CAAC;AAErF,MAAM,MAAM,yBAAyB,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAAC;AAC7E,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC;AAC3E,MAAM,MAAM,SAAS,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;AAChD,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;AACrD,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;AAErE,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;AACpD,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;AAEvE,MAAM,MAAM,eAAe,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAE5D,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC;AACxE,MAAM,MAAM,yBAAyB,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAAC;AAC7E,MAAM,MAAM,0BAA0B,GAAG,OAAO,CAAC,8BAA8B,CAAC,CAAC"}
package/dist/types.js ADDED
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}
@@ -0,0 +1,5 @@
1
+ /** Generated from package.json by `pnpm generate`; do not edit manually. */
2
+ export declare const SDK_VERSION: "0.2.1";
3
+ export declare const SUPPORTED_API_VERSION_RANGE: ">=0.2.1 <0.3.0";
4
+ export declare const OPENAPI_SOURCE_VERSION: "0.2.1";
5
+ //# sourceMappingURL=version.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,eAAO,MAAM,WAAW,EAAG,OAAgB,CAAC;AAC5C,eAAO,MAAM,2BAA2B,EAAG,gBAAyB,CAAC;AACrE,eAAO,MAAM,sBAAsB,EAAG,OAAgB,CAAC"}
@@ -0,0 +1,5 @@
1
+ /** Generated from package.json by `pnpm generate`; do not edit manually. */
2
+ export const SDK_VERSION = "0.2.1";
3
+ export const SUPPORTED_API_VERSION_RANGE = ">=0.2.1 <0.3.0";
4
+ export const OPENAPI_SOURCE_VERSION = "0.2.1";
5
+ //# sourceMappingURL=version.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,MAAM,CAAC,MAAM,WAAW,GAAG,OAAgB,CAAC;AAC5C,MAAM,CAAC,MAAM,2BAA2B,GAAG,gBAAyB,CAAC;AACrE,MAAM,CAAC,MAAM,sBAAsB,GAAG,OAAgB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,72 @@
1
1
  {
2
2
  "name": "@openmeshtak/sdk",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "0.2.1",
4
+ "description": "Official TypeScript and JavaScript client for the OpenMeshTak API",
5
+ "license": "Apache-2.0",
6
+ "type": "module",
7
+ "sideEffects": false,
8
+ "engines": {
9
+ "node": ">=24.0.0",
10
+ "pnpm": ">=10.12.0"
11
+ },
12
+ "packageManager": "pnpm@10.12.4",
13
+ "openmeshtak": {
14
+ "apiVersionRange": ">=0.2.1 <0.3.0",
15
+ "openApiVersion": "0.2.1"
16
+ },
17
+ "files": [
18
+ "dist",
19
+ "LICENSE",
20
+ "README.md"
21
+ ],
22
+ "main": "./dist/index.js",
23
+ "types": "./dist/index.d.ts",
24
+ "exports": {
25
+ ".": {
26
+ "types": "./dist/index.d.ts",
27
+ "import": "./dist/index.js"
28
+ },
29
+ "./generated": {
30
+ "types": "./dist/generated/schema.d.ts",
31
+ "import": "./dist/generated.js"
32
+ }
33
+ },
34
+ "scripts": {
35
+ "api:generate": "openapi-typescript openapi/openapi.json --output src/generated/schema.ts",
36
+ "api:sync": "node scripts/sync-openapi.mjs",
37
+ "generate": "pnpm api:generate && node scripts/write-version-module.mjs",
38
+ "clean": "node scripts/clean.mjs",
39
+ "build": "pnpm clean && pnpm generate && tsc -p tsconfig.build.json",
40
+ "typecheck": "pnpm generate && tsc --noEmit",
41
+ "test": "pnpm build && node --test",
42
+ "license:check": "node scripts/check-licenses.mjs",
43
+ "release:notices": "node scripts/write-release-notices.mjs",
44
+ "version:check": "node scripts/check-version.mjs",
45
+ "version:set": "node scripts/set-version.mjs",
46
+ "check": "pnpm version:check && pnpm typecheck && pnpm test && pnpm license:check",
47
+ "prepack": "pnpm check && pnpm release:notices"
48
+ },
49
+ "dependencies": {
50
+ "openapi-fetch": "0.17.0"
51
+ },
52
+ "devDependencies": {
53
+ "@types/node": "24.10.1",
54
+ "openapi-typescript": "7.13.0",
55
+ "typescript": "5.9.3"
56
+ },
57
+ "repository": {
58
+ "type": "git",
59
+ "url": "git+https://github.com/OpenMeshTAK/openmeshtak-sdk.git"
60
+ },
61
+ "publishConfig": {
62
+ "access": "public",
63
+ "provenance": true,
64
+ "registry": "https://registry.npmjs.org/"
65
+ },
66
+ "keywords": [
67
+ "openmeshtak",
68
+ "tak",
69
+ "meshtastic",
70
+ "openapi"
71
+ ]
72
+ }