@arke-institute/sdk 0.1.3 → 2.1.0

package/openapi/version.json

@@ -0,0 +1,7 @@
+{
+  "specVersion": "1.0.0",
+  "apiVersion": "1.0.0",
+  "fetchedAt": "2025-12-30T18:35:48.207Z",
+  "sourceUrl": "https://arke-v1.arke.institute/openapi.json",
+  "openApiVersion": "3.1.0"
+}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@arke-institute/sdk",
-  "version": "0.1.3",
+  "version": "2.1.0",
+  "description": "TypeScript SDK for the Arke API - auto-generated from OpenAPI spec",
   "type": "module",
-  "description": "TypeScript SDK for building applications on the Arke platform",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -12,77 +12,76 @@
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     },
-    "./collections": {
-      "types": "./dist/collections/index.d.ts",
-      "import": "./dist/collections/index.js",
-      "require": "./dist/collections/index.cjs"
+    "./generated": {
+      "types": "./dist/generated/index.d.ts",
+      "import": "./dist/generated/index.js",
+      "require": "./dist/generated/index.cjs"
     },
-    "./upload": {
-      "types": "./dist/upload/index.d.ts",
-      "import": "./dist/upload/index.js",
-      "require": "./dist/upload/index.cjs"
+    "./operations": {
+      "types": "./dist/operations/index.d.ts",
+      "import": "./dist/operations/index.js",
+      "require": "./dist/operations/index.cjs"
     },
-    "./query": {
-      "types": "./dist/query/index.d.ts",
-      "import": "./dist/query/index.js",
-      "require": "./dist/query/index.cjs"
-    },
-    "./edit": {
-      "types": "./dist/edit/index.d.ts",
-      "import": "./dist/edit/index.js",
-      "require": "./dist/edit/index.cjs"
-    },
-    "./content": {
-      "types": "./dist/content/index.d.ts",
-      "import": "./dist/content/index.js",
-      "require": "./dist/content/index.cjs"
-    },
-    "./graph": {
-      "types": "./dist/graph/index.d.ts",
-      "import": "./dist/graph/index.js",
-      "require": "./dist/graph/index.cjs"
+    "./spec": {
+      "import": "./openapi/spec.json",
+      "require": "./openapi/spec.json"
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "openapi",
+    "README.md"
   ],
   "scripts": {
+    "generate:fetch": "tsx scripts/fetch-spec.ts",
+    "generate:fetch:local": "tsx scripts/fetch-spec.ts --local",
+    "generate:types": "tsx scripts/generate.ts",
+    "generate": "npm run generate:fetch && npm run generate:types",
+    "generate:local": "npm run generate:fetch:local && npm run generate:types",
     "build": "tsup",
     "dev": "tsup --watch",
-    "typecheck": "tsc --noEmit",
     "test": "vitest run",
+    "test:watch": "vitest",
+    "test:e2e": "vitest run --config vitest.e2e.config.ts",
+    "typecheck": "tsc --noEmit",
     "clean": "rm -rf dist",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "publish:dry": "npm publish --dry-run",
+    "publish:sdk": "npm publish --access public",
+    "publish-all": "npm run generate && npm run test && npm run build && npm run publish:sdk",
+    "publish-all:dry": "npm run generate && npm run test && npm run build && npm run publish:dry"
   },
   "dependencies": {
-    "diff": "^7.0.0",
-    "multiformats": "^13.4.1"
+    "multiformats": "^13.4.2",
+    "openapi-fetch": "^0.13.0"
   },
   "devDependencies": {
-    "@types/diff": "^7.0.0",
-    "@types/node": "^20.10.0",
-    "tsup": "^8.0.0",
-    "typescript": "^5.3.0",
-    "vitest": "^1.0.0"
+    "@types/node": "^22.0.0",
+    "jose": "^6.1.3",
+    "openapi-typescript": "^7.4.0",
+    "tsup": "^8.3.0",
+    "tsx": "^4.19.0",
+    "typescript": "^5.7.0",
+    "vitest": "^2.1.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/arke-institute/arke"
   },
   "keywords": [
     "arke",
+    "api",
     "sdk",
-    "collections",
-    "upload",
-    "query",
-    "edit",
-    "knowledge-graph",
-    "content",
-    "typescript"
+    "typescript",
+    "ipfs",
+    "entities"
   ],
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Arke-Institute/arke-sdk"
-  },
   "author": "Arke Institute",
+  "license": "MIT",
   "engines": {
-    "node": ">=18"
+    "node": ">=18.0.0"
   }
 }

package/dist/client-dAk3E64p.d.cts

@@ -1,183 +0,0 @@
-type CollectionVisibility = 'public' | 'private';
-type CollectionRole = 'owner' | 'editor';
-interface Collection {
-    id: string;
-    title: string;
-    slug: string;
-    description?: string | null;
-    visibility: CollectionVisibility;
-    creator_user_id?: string;
-    created_at?: string;
-    updated_at?: string;
-}
-interface CollectionDetails extends Collection {
-    member_count: number;
-    root_pi: string | null;
-    users?: {
-        email?: string;
-        name?: string | null;
-    };
-}
-interface PaginatedCollections {
-    collections: CollectionDetails[];
-    pagination: {
-        total: number | null;
-        limit: number;
-        offset: number;
-    };
-}
-interface MemberUser {
-    id: string;
-    email: string;
-    name?: string | null;
-}
-interface Member {
-    role: CollectionRole;
-    created_at?: string;
-    user: MemberUser;
-}
-interface MembersResponse {
-    members: Member[];
-}
-interface InvitationUser {
-    email: string;
-    name?: string | null;
-}
-interface Invitation {
-    id: string;
-    role: CollectionRole;
-    status: 'pending' | 'accepted' | 'declined' | 'expired';
-    expires_at: string;
-    created_at: string;
-    responded_at?: string | null;
-    invitee?: InvitationUser;
-    inviter?: InvitationUser;
-    collection?: {
-        id: string;
-        title: string;
-        slug: string;
-    };
-}
-interface InvitationsResponse {
-    invitations: Invitation[];
-}
-interface CreateCollectionPayload {
-    title: string;
-    slug: string;
-    description?: string;
-    visibility?: CollectionVisibility;
-}
-interface RegisterRootPayload extends CreateCollectionPayload {
-    rootPi: string;
-}
-interface UpdateCollectionPayload {
-    title?: string;
-    description?: string;
-    visibility?: CollectionVisibility;
-}
-interface ChangeRootPayload {
-    newRootPi: string;
-}
-interface MyCollectionsResponse {
-    owned: Array<Collection & {
-        role: CollectionRole;
-    }>;
-    editing: Array<Collection & {
-        role: CollectionRole;
-    }>;
-    total: number;
-}
-interface MyAccessResponse {
-    isMember: boolean;
-    role: CollectionRole | null;
-    canView: boolean;
-    canEdit: boolean;
-    canInvite: boolean;
-    canManageMembers: boolean;
-    canDelete: boolean;
-}
-interface RootResponse {
-    rootPi: string;
-}
-interface ChangeRootResponse {
-    previousRoot: string | null;
-    newRoot: string;
-}
-interface SuccessResponse {
-    success: boolean;
-}
-interface PiPermissions {
-    pi: string;
-    canView: boolean;
-    canEdit: boolean;
-    canAdminister: boolean;
-    collection: {
-        id: string;
-        title: string;
-        slug: string;
-        visibility: CollectionVisibility;
-        role: CollectionRole | null;
-        rootPi: string;
-        hops: number;
-    } | null;
-}
-
-interface CollectionsClientConfig {
-    /**
-     * Gateway base URL (e.g., https://api.arke.institute).
-     * Must already point at the Arke gateway that proxies /collections/*.
-     */
-    gatewayUrl: string;
-    /**
-     * Optional bearer token for authenticated routes.
-     * Public routes will still include it if provided.
-     */
-    authToken?: string;
-    /**
-     * Optional custom fetch (useful for testing).
-     */
-    fetchImpl?: typeof fetch;
-}
-declare class CollectionsClient {
-    private baseUrl;
-    private authToken?;
-    private fetchImpl;
-    constructor(config: CollectionsClientConfig);
-    setAuthToken(token?: string): void;
-    private buildUrl;
-    private getHeaders;
-    private request;
-    listCollections(params?: {
-        limit?: number;
-        offset?: number;
-    }): Promise<PaginatedCollections>;
-    getCollection(id: string): Promise<CollectionDetails>;
-    getCollectionRoot(id: string): Promise<RootResponse>;
-    getMyAccess(id: string): Promise<MyAccessResponse>;
-    createCollection(payload: CreateCollectionPayload): Promise<Collection>;
-    registerRoot(payload: RegisterRootPayload): Promise<Collection & {
-        rootPi: string;
-    }>;
-    updateCollection(id: string, payload: UpdateCollectionPayload): Promise<Collection>;
-    changeRoot(id: string, payload: ChangeRootPayload): Promise<ChangeRootResponse>;
-    deleteCollection(id: string): Promise<SuccessResponse>;
-    listMembers(collectionId: string): Promise<MembersResponse>;
-    updateMemberRole(collectionId: string, userId: string, role: CollectionRole): Promise<{
-        success: true;
-        role: CollectionRole;
-    }>;
-    removeMember(collectionId: string, userId: string): Promise<SuccessResponse>;
-    createInvitation(collectionId: string, email: string, role: CollectionRole): Promise<Invitation>;
-    listInvitations(collectionId: string): Promise<InvitationsResponse>;
-    acceptInvitation(invitationId: string): Promise<{
-        success: true;
-        role: CollectionRole;
-    }>;
-    declineInvitation(invitationId: string): Promise<SuccessResponse>;
-    revokeInvitation(invitationId: string): Promise<SuccessResponse>;
-    getMyCollections(): Promise<MyCollectionsResponse>;
-    getMyInvitations(): Promise<InvitationsResponse>;
-    getPiPermissions(pi: string): Promise<PiPermissions>;
-}
-
-export { CollectionsClient as C, type Invitation as I, type Member as M, type PaginatedCollections as P, type RegisterRootPayload as R, type SuccessResponse as S, type UpdateCollectionPayload as U, type CollectionsClientConfig as a, type Collection as b, type CollectionDetails as c, type CollectionRole as d, type CollectionVisibility as e, type CreateCollectionPayload as f, type ChangeRootPayload as g, type ChangeRootResponse as h, type MemberUser as i, type MembersResponse as j, type InvitationUser as k, type InvitationsResponse as l, type MyAccessResponse as m, type MyCollectionsResponse as n, type PiPermissions as o, type RootResponse as p };

package/dist/client-dAk3E64p.d.ts

@@ -1,183 +0,0 @@
-type CollectionVisibility = 'public' | 'private';
-type CollectionRole = 'owner' | 'editor';
-interface Collection {
-    id: string;
-    title: string;
-    slug: string;
-    description?: string | null;
-    visibility: CollectionVisibility;
-    creator_user_id?: string;
-    created_at?: string;
-    updated_at?: string;
-}
-interface CollectionDetails extends Collection {
-    member_count: number;
-    root_pi: string | null;
-    users?: {
-        email?: string;
-        name?: string | null;
-    };
-}
-interface PaginatedCollections {
-    collections: CollectionDetails[];
-    pagination: {
-        total: number | null;
-        limit: number;
-        offset: number;
-    };
-}
-interface MemberUser {
-    id: string;
-    email: string;
-    name?: string | null;
-}
-interface Member {
-    role: CollectionRole;
-    created_at?: string;
-    user: MemberUser;
-}
-interface MembersResponse {
-    members: Member[];
-}
-interface InvitationUser {
-    email: string;
-    name?: string | null;
-}
-interface Invitation {
-    id: string;
-    role: CollectionRole;
-    status: 'pending' | 'accepted' | 'declined' | 'expired';
-    expires_at: string;
-    created_at: string;
-    responded_at?: string | null;
-    invitee?: InvitationUser;
-    inviter?: InvitationUser;
-    collection?: {
-        id: string;
-        title: string;
-        slug: string;
-    };
-}
-interface InvitationsResponse {
-    invitations: Invitation[];
-}
-interface CreateCollectionPayload {
-    title: string;
-    slug: string;
-    description?: string;
-    visibility?: CollectionVisibility;
-}
-interface RegisterRootPayload extends CreateCollectionPayload {
-    rootPi: string;
-}
-interface UpdateCollectionPayload {
-    title?: string;
-    description?: string;
-    visibility?: CollectionVisibility;
-}
-interface ChangeRootPayload {
-    newRootPi: string;
-}
-interface MyCollectionsResponse {
-    owned: Array<Collection & {
-        role: CollectionRole;
-    }>;
-    editing: Array<Collection & {
-        role: CollectionRole;
-    }>;
-    total: number;
-}
-interface MyAccessResponse {
-    isMember: boolean;
-    role: CollectionRole | null;
-    canView: boolean;
-    canEdit: boolean;
-    canInvite: boolean;
-    canManageMembers: boolean;
-    canDelete: boolean;
-}
-interface RootResponse {
-    rootPi: string;
-}
-interface ChangeRootResponse {
-    previousRoot: string | null;
-    newRoot: string;
-}
-interface SuccessResponse {
-    success: boolean;
-}
-interface PiPermissions {
-    pi: string;
-    canView: boolean;
-    canEdit: boolean;
-    canAdminister: boolean;
-    collection: {
-        id: string;
-        title: string;
-        slug: string;
-        visibility: CollectionVisibility;
-        role: CollectionRole | null;
-        rootPi: string;
-        hops: number;
-    } | null;
-}
-
-interface CollectionsClientConfig {
-    /**
-     * Gateway base URL (e.g., https://api.arke.institute).
-     * Must already point at the Arke gateway that proxies /collections/*.
-     */
-    gatewayUrl: string;
-    /**
-     * Optional bearer token for authenticated routes.
-     * Public routes will still include it if provided.
-     */
-    authToken?: string;
-    /**
-     * Optional custom fetch (useful for testing).
-     */
-    fetchImpl?: typeof fetch;
-}
-declare class CollectionsClient {
-    private baseUrl;
-    private authToken?;
-    private fetchImpl;
-    constructor(config: CollectionsClientConfig);
-    setAuthToken(token?: string): void;
-    private buildUrl;
-    private getHeaders;
-    private request;
-    listCollections(params?: {
-        limit?: number;
-        offset?: number;
-    }): Promise<PaginatedCollections>;
-    getCollection(id: string): Promise<CollectionDetails>;
-    getCollectionRoot(id: string): Promise<RootResponse>;
-    getMyAccess(id: string): Promise<MyAccessResponse>;
-    createCollection(payload: CreateCollectionPayload): Promise<Collection>;
-    registerRoot(payload: RegisterRootPayload): Promise<Collection & {
-        rootPi: string;
-    }>;
-    updateCollection(id: string, payload: UpdateCollectionPayload): Promise<Collection>;
-    changeRoot(id: string, payload: ChangeRootPayload): Promise<ChangeRootResponse>;
-    deleteCollection(id: string): Promise<SuccessResponse>;
-    listMembers(collectionId: string): Promise<MembersResponse>;
-    updateMemberRole(collectionId: string, userId: string, role: CollectionRole): Promise<{
-        success: true;
-        role: CollectionRole;
-    }>;
-    removeMember(collectionId: string, userId: string): Promise<SuccessResponse>;
-    createInvitation(collectionId: string, email: string, role: CollectionRole): Promise<Invitation>;
-    listInvitations(collectionId: string): Promise<InvitationsResponse>;
-    acceptInvitation(invitationId: string): Promise<{
-        success: true;
-        role: CollectionRole;
-    }>;
-    declineInvitation(invitationId: string): Promise<SuccessResponse>;
-    revokeInvitation(invitationId: string): Promise<SuccessResponse>;
-    getMyCollections(): Promise<MyCollectionsResponse>;
-    getMyInvitations(): Promise<InvitationsResponse>;
-    getPiPermissions(pi: string): Promise<PiPermissions>;
-}
-
-export { CollectionsClient as C, type Invitation as I, type Member as M, type PaginatedCollections as P, type RegisterRootPayload as R, type SuccessResponse as S, type UpdateCollectionPayload as U, type CollectionsClientConfig as a, type Collection as b, type CollectionDetails as c, type CollectionRole as d, type CollectionVisibility as e, type CreateCollectionPayload as f, type ChangeRootPayload as g, type ChangeRootResponse as h, type MemberUser as i, type MembersResponse as j, type InvitationUser as k, type InvitationsResponse as l, type MyAccessResponse as m, type MyCollectionsResponse as n, type PiPermissions as o, type RootResponse as p };