@ariestools/aries-datalake-client 0.1.13

package/dist/node/PayloadsClient.d.ts

@@ -0,0 +1,73 @@
+import type { InsertPayloadsResult, NextPayloadsOptions, NextPayloadsResult, Payload, WithStorageMeta } from '@ariestools/aries-datalake-core/browser';
+import type { AuthTokenSource } from './AuthToken.ts';
+export interface DatalakeUsageReport {
+    datalakeId: string;
+    payloadCount: number;
+    rateLimits?: {
+        anonymous?: {
+            limit: number;
+            remaining: number;
+        };
+        authenticated?: {
+            limit: number;
+            remaining: number;
+        };
+    };
+}
+/**
+ * HTTP client for a single datalake's data plane. Clients send bare
+ * `Payload` objects (no `_hash` / `_dataHash` — those are stamped on
+ * insert by the data plane's archivist). Responses always carry the
+ * archivist-computed storage meta.
+ *
+ * Wire format mirrors the XYO archivist REST middleware: `/insert`,
+ * `/get/:hash`, `/next`, bare arrays as bodies. Datalake-specific
+ * extras (duplicates count, rejected hashes, next cursor) are delivered
+ * via response headers.
+ */
+export interface PayloadsClient {
+    clear(): Promise<{
+        removed: number;
+    }>;
+    delete(hash: string): Promise<void>;
+    get(hash: string): Promise<WithStorageMeta<Payload>>;
+    getMany(hashes: string[]): Promise<WithStorageMeta<Payload>[]>;
+    insert(payloads: Payload[]): Promise<InsertPayloadsResult>;
+    next(options?: NextPayloadsOptions): Promise<NextPayloadsResult>;
+    usage(): Promise<DatalakeUsageReport>;
+}
+/**
+ * Either a static bearer token, or a factory invoked per-request. The factory
+ * form lets callers mint a fresh self-signed wallet JWT per call (with
+ * `aud` bound to the datalake id).
+ */
+export type PayloadsAuthTokenSource = AuthTokenSource;
+export interface RestPayloadsClientOptions {
+    /** Static bearer token, or async factory minted per-request. */
+    authToken: PayloadsAuthTokenSource;
+    /** Data-plane base URL without trailing slash. */
+    baseUrl: string;
+    /** Datalake id; appended to `/v1/datalakes/:id/...`. */
+    datalakeId: string;
+    /** Optional `fetch` override; defaults to global `fetch`. */
+    fetchImpl?: typeof fetch;
+}
+export declare class RestPayloadsClient implements PayloadsClient {
+    private readonly authToken;
+    private readonly datalakeId;
+    private readonly fetchImpl;
+    private readonly origin;
+    constructor(options: RestPayloadsClientOptions);
+    clear(): Promise<{
+        removed: number;
+    }>;
+    delete(hash: string): Promise<void>;
+    get(hash: string): Promise<WithStorageMeta<Payload>>;
+    getMany(hashes: string[]): Promise<WithStorageMeta<Payload>[]>;
+    insert(payloads: Payload[]): Promise<InsertPayloadsResult>;
+    next(options?: NextPayloadsOptions): Promise<NextPayloadsResult>;
+    usage(): Promise<DatalakeUsageReport>;
+    private request;
+    private requestWithHeaders;
+}
+//# sourceMappingURL=PayloadsClient.d.ts.map

package/dist/node/PayloadsClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PayloadsClient.d.ts","sourceRoot":"","sources":["../../src/PayloadsClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAKV,oBAAoB,EACpB,mBAAmB,EAEnB,kBAAkB,EAClB,OAAO,EACP,eAAe,EAChB,MAAM,yCAAyC,CAAA;AAehD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAGrD,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE;QACX,SAAS,CAAC,EAAE;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,SAAS,EAAE,MAAM,CAAA;SAAE,CAAA;QAChD,aAAa,CAAC,EAAE;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,SAAS,EAAE,MAAM,CAAA;SAAE,CAAA;KACrD,CAAA;CACF;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,cAAc;IAC7B,KAAK,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IACrC,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACnC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;IACpD,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IAC9D,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAC1D,IAAI,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAChE,KAAK,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAAA;CACtC;AAED;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,eAAe,CAAA;AAErD,MAAM,WAAW,yBAAyB;IACxC,gEAAgE;IAChE,SAAS,EAAE,uBAAuB,CAAA;IAClC,kDAAkD;IAClD,OAAO,EAAE,MAAM,CAAA;IACf,wDAAwD;IACxD,UAAU,EAAE,MAAM,CAAA;IAClB,6DAA6D;IAC7D,SAAS,CAAC,EAAE,OAAO,KAAK,CAAA;CACzB;AA2BD,qBAAa,kBAAmB,YAAW,cAAc;IACvD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAyB;IACnD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAQ;IACnC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAc;IACxC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;gBAEnB,OAAO,EAAE,yBAAyB;IAOxC,KAAK,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAOrC,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOnC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAIpD,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;IAQ9D,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAY1D,IAAI,CAAC,OAAO,GAAE,mBAAwB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAepE,KAAK,IAAI,OAAO,CAAC,mBAAmB,CAAC;YAI7B,OAAO;YAKP,kBAAkB;CAkCjC"}

package/dist/node/RestDatalakeClient.d.ts

@@ -0,0 +1,33 @@
+import type { DatalakeDescriptor, DatalakeToken } from '@ariestools/aries-datalake-core/browser';
+import type { AuthTokenSource } from './AuthToken.ts';
+import type { CreateDatalakeRequest, DatalakeClient, GrantRequest, RevokeRequest, TokenRequest } from './DatalakeClient.ts';
+export interface RestDatalakeClientOptions {
+    /** Exact control-plane JWT audience. */
+    audience?: string;
+    /** Static token, or async factory minted per-request. */
+    authToken: AuthTokenSource;
+    /** Control-plane base URL, e.g. `https://dl-control.xylabs.io`. */
+    baseUrl: string;
+    /** Optional `fetch` override; defaults to global `fetch`. */
+    fetchImpl?: typeof fetch;
+}
+/**
+ * HTTP client for the datalake control plane. Implements the stable
+ * `DatalakeClient` contract so callers are independent of transport.
+ */
+export declare class RestDatalakeClient implements DatalakeClient {
+    private readonly audience;
+    private readonly authToken;
+    private readonly baseUrl;
+    private readonly fetchImpl;
+    constructor(options: RestDatalakeClientOptions);
+    create(request: CreateDatalakeRequest): Promise<DatalakeDescriptor>;
+    describe(idOrName: string): Promise<DatalakeDescriptor>;
+    destroy(idOrName: string): Promise<void>;
+    grant(request: GrantRequest): Promise<DatalakeDescriptor>;
+    list(): Promise<DatalakeDescriptor[]>;
+    mintToken(request: TokenRequest): Promise<DatalakeToken>;
+    revoke(request: RevokeRequest): Promise<DatalakeDescriptor>;
+    private request;
+}
+//# sourceMappingURL=RestDatalakeClient.d.ts.map

package/dist/node/RestDatalakeClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RestDatalakeClient.d.ts","sourceRoot":"","sources":["../../src/RestDatalakeClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAGV,kBAAkB,EAClB,aAAa,EAGd,MAAM,yCAAyC,CAAA;AAWhD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAErD,OAAO,KAAK,EACV,qBAAqB,EACrB,cAAc,EACd,YAAY,EACZ,aAAa,EACb,YAAY,EACb,MAAM,qBAAqB,CAAA;AAE5B,MAAM,WAAW,yBAAyB;IACxC,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,yDAAyD;IACzD,SAAS,EAAE,eAAe,CAAA;IAC1B,mEAAmE;IACnE,OAAO,EAAE,MAAM,CAAA;IACf,6DAA6D;IAC7D,SAAS,CAAC,EAAE,OAAO,KAAK,CAAA;CACzB;AAOD;;;GAGG;AACH,qBAAa,kBAAmB,YAAW,cAAc;IACvD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IACjC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAiB;IAC3C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAQ;IAChC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAc;gBAE5B,OAAO,EAAE,yBAAyB;IAOxC,MAAM,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAKnE,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAIvD,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxC,KAAK,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAQzD,IAAI,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAIrC,SAAS,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,aAAa,CAAC;IAQxD,MAAM,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,kBAAkB,CAAC;YAOnD,OAAO;CAqCtB"}

package/dist/node/browser.d.ts

@@ -0,0 +1,8 @@
+export type { AuthTokenRequest, AuthTokenSource, AuthTokenSupplier, } from './AuthToken.ts';
+export type { CreateDatalakeRequest, DatalakeClient, GrantRequest, RevokeRequest, TokenRequest, } from './DatalakeClient.ts';
+export type { DatalakeUsageReport, PayloadsAuthTokenSource, PayloadsClient, RestPayloadsClientOptions, } from './PayloadsClient.ts';
+export { RestPayloadsClient } from './PayloadsClient.ts';
+export type { RestDatalakeClientOptions } from './RestDatalakeClient.ts';
+export { RestDatalakeClient } from './RestDatalakeClient.ts';
+export * from '@ariestools/aries-datalake-core/browser';
+//# sourceMappingURL=browser.d.ts.map

package/dist/node/browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../src/browser.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,gBAAgB,EAAE,eAAe,EAAE,iBAAiB,GACrD,MAAM,gBAAgB,CAAA;AACvB,YAAY,EACV,qBAAqB,EACrB,cAAc,EACd,YAAY,EACZ,aAAa,EACb,YAAY,GACb,MAAM,qBAAqB,CAAA;AAC5B,YAAY,EACV,mBAAmB,EACnB,uBAAuB,EACvB,cAAc,EACd,yBAAyB,GAC1B,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AACxD,YAAY,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAA;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAC5D,cAAc,yCAAyC,CAAA"}

package/dist/node/createDatalakeClient.d.ts

@@ -0,0 +1,24 @@
+import type { AuthTokenSource } from './AuthToken.ts';
+import type { DatalakeClient } from './DatalakeClient.ts';
+export interface CreateDatalakeClientOptions {
+    /**
+     * Override the auth token (otherwise read from credentials). Accepts either
+     * a static bearer string or an async factory — pass a factory when minting
+     * self-signed wallet JWTs per request.
+     */
+    authToken?: AuthTokenSource;
+    /** Override the control-plane URL (otherwise read from env / credentials). */
+    baseUrl?: string;
+    /**
+     * Force a specific driver. Defaults to:
+     *   - `rest` when `ARIES_DATALAKE_API` is set or credentials are present
+     *   - `local` otherwise
+     */
+    driver?: 'local' | 'rest';
+}
+/**
+ * Returns a `DatalakeClient` wired for the current environment. The CLI uses
+ * this factory so every command picks up the same resolution rules.
+ */
+export declare function createDatalakeClient(options?: CreateDatalakeClientOptions): DatalakeClient;
+//# sourceMappingURL=createDatalakeClient.d.ts.map

package/dist/node/createDatalakeClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createDatalakeClient.d.ts","sourceRoot":"","sources":["../../src/createDatalakeClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAErD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAIzD,MAAM,WAAW,2BAA2B;IAC1C;;;;OAIG;IACH,SAAS,CAAC,EAAE,eAAe,CAAA;IAC3B,8EAA8E;IAC9E,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM,CAAA;CAC1B;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,GAAE,2BAAgC,GAAG,cAAc,CAoB9F"}

package/dist/node/credentials.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Hints for self-signed wallet-JWT mode. When present, the CLI is expected to
+ * mint a fresh ES256K JWT per request using the active aries wallet. The
+ * server-side `authToken` field is unused in this mode.
+ */
+export interface WalletJwtCredentials {
+    /** `aud` claim to use for control-plane calls (default `aries-datalake-control`). */
+    controlAudience?: string;
+    /** Derivation offset of the signing account (default `'0'`). */
+    offset?: string;
+    /** TTL (seconds) for each minted JWT (default `120`). */
+    ttlSeconds?: number;
+}
+export interface StoredCredentials {
+    /**
+     * Static bearer token for legacy/static-token mode. Absent when `walletJwt`
+     * mode is configured — the CLI mints a token per request instead.
+     */
+    authToken?: string;
+    baseUrl: string;
+    /** ISO-8601 expiration of the access token. */
+    expiresAt?: string;
+    /** Optional refresh token for long-lived sessions. */
+    refreshToken?: string;
+    userId?: string;
+    /** Wallet-JWT mode hints. When set, the CLI mints self-signed JWTs. */
+    walletJwt?: WalletJwtCredentials;
+}
+export declare function saveCredentials(credentials: StoredCredentials): void;
+export declare function loadCredentials(): StoredCredentials | undefined;
+export declare function clearCredentials(): void;
+export declare function getCredentialsLocation(): string;
+//# sourceMappingURL=credentials.d.ts.map

package/dist/node/credentials.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"credentials.d.ts","sourceRoot":"","sources":["../../src/credentials.ts"],"names":[],"mappings":"AAOA;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,qFAAqF;IACrF,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,gEAAgE;IAChE,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,yDAAyD;IACzD,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,+CAA+C;IAC/C,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,sDAAsD;IACtD,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,uEAAuE;IACvE,SAAS,CAAC,EAAE,oBAAoB,CAAA;CACjC;AAED,wBAAgB,eAAe,CAAC,WAAW,EAAE,iBAAiB,GAAG,IAAI,CAUpE;AAED,wBAAgB,eAAe,IAAI,iBAAiB,GAAG,SAAS,CAS/D;AAED,wBAAgB,gBAAgB,IAAI,IAAI,CAGvC;AAED,wBAAgB,sBAAsB,IAAI,MAAM,CAE/C"}

package/dist/node/defaultDatalake.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Remembers which datalake the user selected via `aries datalake use`. Read by
+ * commands that accept an optional `<name>` and fall back to the default.
+ */
+export declare function setDefaultDatalake(name: string, id?: string): void;
+export declare function getDefaultDatalake(): string | undefined;
+export declare function clearDefaultDatalake(): void;
+//# sourceMappingURL=defaultDatalake.d.ts.map

package/dist/node/defaultDatalake.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultDatalake.d.ts","sourceRoot":"","sources":["../../src/defaultDatalake.ts"],"names":[],"mappings":"AAYA;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAOlE;AAED,wBAAgB,kBAAkB,IAAI,MAAM,GAAG,SAAS,CAUvD;AAED,wBAAgB,oBAAoB,IAAI,IAAI,CAG3C"}

package/dist/node/index.d.ts

@@ -0,0 +1,13 @@
+export type { AuthTokenRequest, AuthTokenSource, AuthTokenSupplier, } from './AuthToken.ts';
+export type { CreateDatalakeClientOptions } from './createDatalakeClient.ts';
+export { createDatalakeClient } from './createDatalakeClient.ts';
+export type { StoredCredentials, WalletJwtCredentials } from './credentials.ts';
+export { clearCredentials, getCredentialsLocation, loadCredentials, saveCredentials, } from './credentials.ts';
+export type { CreateDatalakeRequest, DatalakeClient, GrantRequest, RevokeRequest, TokenRequest, } from './DatalakeClient.ts';
+export { clearDefaultDatalake, getDefaultDatalake, setDefaultDatalake, } from './defaultDatalake.ts';
+export { getLocalStoreLocation, LocalDatalakeClient } from './LocalDatalakeClient.ts';
+export type { DatalakeUsageReport, PayloadsAuthTokenSource, PayloadsClient, RestPayloadsClientOptions, } from './PayloadsClient.ts';
+export { RestPayloadsClient } from './PayloadsClient.ts';
+export type { RestDatalakeClientOptions } from './RestDatalakeClient.ts';
+export { RestDatalakeClient } from './RestDatalakeClient.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,gBAAgB,EAAE,eAAe,EAAE,iBAAiB,GACrD,MAAM,gBAAgB,CAAA;AACvB,YAAY,EAAE,2BAA2B,EAAE,MAAM,2BAA2B,CAAA;AAC5E,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AAChE,YAAY,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAA;AAC/E,OAAO,EACL,gBAAgB,EAAE,sBAAsB,EAAE,eAAe,EAAE,eAAe,GAC3E,MAAM,kBAAkB,CAAA;AACzB,YAAY,EACV,qBAAqB,EACrB,cAAc,EACd,YAAY,EACZ,aAAa,EACb,YAAY,GACb,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EACL,oBAAoB,EAAE,kBAAkB,EAAE,kBAAkB,GAC7D,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AACrF,YAAY,EACV,mBAAmB,EACnB,uBAAuB,EACvB,cAAc,EACd,yBAAyB,GAC1B,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AACxD,YAAY,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAA;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA"}