@ariestools/datalake-cli 0.0.0-stage → 0.3.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.
- package/LICENSE +4 -0
- package/README.md +40 -2
- package/dist/node/actions/datalake/login.d.ts +30 -0
- package/dist/node/actions/datalake/login.d.ts.map +1 -0
- package/dist/node/bin/daemons/datalake-dev.mjs +141540 -0
- package/dist/node/bin/datalake.d.ts +3 -0
- package/dist/node/bin/datalake.d.ts.map +1 -0
- package/dist/node/bin/datalake.mjs +232306 -0
- package/dist/node/commands/datalakeAuditCommand.d.ts +3 -0
- package/dist/node/commands/datalakeAuditCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeBlobCheckCommand.d.ts +3 -0
- package/dist/node/commands/datalakeBlobCheckCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeBlobClearCommand.d.ts +3 -0
- package/dist/node/commands/datalakeBlobClearCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeBlobCommand.d.ts +7 -0
- package/dist/node/commands/datalakeBlobCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeBlobCreateCommand.d.ts +3 -0
- package/dist/node/commands/datalakeBlobCreateCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeBlobFetchCommand.d.ts +3 -0
- package/dist/node/commands/datalakeBlobFetchCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeBlobListCommand.d.ts +3 -0
- package/dist/node/commands/datalakeBlobListCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeBlobOptions.d.ts +23 -0
- package/dist/node/commands/datalakeBlobOptions.d.ts.map +1 -0
- package/dist/node/commands/datalakeBlobPushCommand.d.ts +3 -0
- package/dist/node/commands/datalakeBlobPushCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeBlobRmCommand.d.ts +3 -0
- package/dist/node/commands/datalakeBlobRmCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeBlobStatCommand.d.ts +3 -0
- package/dist/node/commands/datalakeBlobStatCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeBlobTokenCommand.d.ts +3 -0
- package/dist/node/commands/datalakeBlobTokenCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeBlobUsageCommand.d.ts +3 -0
- package/dist/node/commands/datalakeBlobUsageCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeCommand.d.ts +15 -0
- package/dist/node/commands/datalakeCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeCreateCommand.d.ts +3 -0
- package/dist/node/commands/datalakeCreateCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeDescribeCommand.d.ts +3 -0
- package/dist/node/commands/datalakeDescribeCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeDestroyCommand.d.ts +3 -0
- package/dist/node/commands/datalakeDestroyCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeDevBootstrapCommand.d.ts +3 -0
- package/dist/node/commands/datalakeDevBootstrapCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeDevCommand.d.ts +8 -0
- package/dist/node/commands/datalakeDevCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeDevDownCommand.d.ts +3 -0
- package/dist/node/commands/datalakeDevDownCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeDevLogsCommand.d.ts +3 -0
- package/dist/node/commands/datalakeDevLogsCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeDevResetCommand.d.ts +3 -0
- package/dist/node/commands/datalakeDevResetCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeDevStatusCommand.d.ts +3 -0
- package/dist/node/commands/datalakeDevStatusCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeDevUpBlobsCommand.d.ts +7 -0
- package/dist/node/commands/datalakeDevUpBlobsCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeDevUpCommand.d.ts +19 -0
- package/dist/node/commands/datalakeDevUpCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeFetchCommand.d.ts +3 -0
- package/dist/node/commands/datalakeFetchCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeGrantCommand.d.ts +3 -0
- package/dist/node/commands/datalakeGrantCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeListCommand.d.ts +3 -0
- package/dist/node/commands/datalakeListCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeLoginCommand.d.ts +23 -0
- package/dist/node/commands/datalakeLoginCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeLoginInternalCommand.d.ts +28 -0
- package/dist/node/commands/datalakeLoginInternalCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeLogoutCommand.d.ts +3 -0
- package/dist/node/commands/datalakeLogoutCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakePushCommand.d.ts +3 -0
- package/dist/node/commands/datalakePushCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeRevokeCommand.d.ts +3 -0
- package/dist/node/commands/datalakeRevokeCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeTailCommand.d.ts +3 -0
- package/dist/node/commands/datalakeTailCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeTokenCommand.d.ts +3 -0
- package/dist/node/commands/datalakeTokenCommand.d.ts.map +1 -0
- package/dist/node/commands/datalakeUseCommand.d.ts +3 -0
- package/dist/node/commands/datalakeUseCommand.d.ts.map +1 -0
- package/dist/node/index.d.ts +346 -0
- package/dist/node/index.mjs +202 -0
- package/dist/node/index.mjs.map +7 -0
- package/dist/node/internal.d.ts +10 -0
- package/dist/node/internal.d.ts.map +1 -0
- package/dist/node/retainedDatalake.d.ts +17 -0
- package/dist/node/retainedDatalake.d.ts.map +1 -0
- package/dist/node/retainedDatalakeChild.d.ts +13 -0
- package/dist/node/retainedDatalakeChild.d.ts.map +1 -0
- package/dist/node/retainedDatalakeWorker.d.ts +2 -0
- package/dist/node/retainedDatalakeWorker.d.ts.map +1 -0
- package/dist/node/retainedDatalakeWorker.mjs +174819 -0
- package/dist/node/runDatalakeProcess.d.ts +4 -0
- package/dist/node/runDatalakeProcess.d.ts.map +1 -0
- package/package.json +88 -3
package/LICENSE
ADDED
package/README.md
CHANGED
|
@@ -1,3 +1,41 @@
|
|
|
1
|
-
#
|
|
1
|
+
# `@ariestools/datalake-cli`
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Datalake command tree for Aries. `aries datalake` and `ariesi datalake` spawn the `aries-datalake` bin. A direct launch is `aries-datalake <command>`.
|
|
4
|
+
|
|
5
|
+
`ARIES_DATALAKE_SURFACE=internal` adds the internal blob commands. `ariesi` sets that only at the internal tier. The public `aries` binary does not.
|
|
6
|
+
|
|
7
|
+
`datalake dev` runs `daemons/datalake-dev.mjs` from beside this bin.
|
|
8
|
+
|
|
9
|
+
## Library
|
|
10
|
+
|
|
11
|
+
The package's root export is the programmatic datalake surface that `@ariestools/cli/datalake` used to ship. It re-exports the public client and core APIs and the dev-server inspection, and adds `startRetainedDatalake`, a local datalake for fixtures:
|
|
12
|
+
|
|
13
|
+
```ts
|
|
14
|
+
import { createDatalakeClient, ExactRootArchive, startRetainedDatalake } from '@ariestools/datalake-cli'
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
`startRetainedDatalake` forks `retainedDatalakeWorker.mjs` from beside the library. The worker bundles the private control and plane, so installing this package needs no private or restricted package.
|
|
18
|
+
|
|
19
|
+
Its type declarations are the facade's own: self-contained, with payloads typed as JSON values and the payload client taking and returning `unknown`, so code written against `@ariestools/cli/datalake` compiles once its import path changes.
|
|
20
|
+
|
|
21
|
+
### Retained local datalake
|
|
22
|
+
|
|
23
|
+
`startRetainedDatalake` starts a datalake for disposable local
|
|
24
|
+
qualification. It owns an isolated loopback worker and returns `url`, `restart()`
|
|
25
|
+
and `stop()`. Supply an absolute `directory` and, for a new corpus, a
|
|
26
|
+
`DatalakeDescriptor`. The directory holds public descriptor/payload data only;
|
|
27
|
+
the signing secret is ephemeral. Restart retains the endpoint and refuses to
|
|
28
|
+
recreate a missing descriptor or overwrite a conflicting descriptor. A successful
|
|
29
|
+
stop means the owned child and its pipes have closed. Readiness and stop deadlines
|
|
30
|
+
are configurable positive integers up to 60 seconds.
|
|
31
|
+
|
|
32
|
+
Optional `initialPayloads` seed at most 4096 public bodies and 16 MiB into a newly
|
|
33
|
+
created descriptor. They are never replayed during restart; trying to seed an
|
|
34
|
+
existing descriptor fails. This is a local fixture facility, not a managed
|
|
35
|
+
production service or an account recovery journal.
|
|
36
|
+
|
|
37
|
+
The same export provides `ExactRootArchive` and its self-contained types.
|
|
38
|
+
It requires a trusted native-root `identify` callback, explicit resource limits,
|
|
39
|
+
and an append-only token supplier. Reads are anonymous and verify original roots.
|
|
40
|
+
A matching hash establishes integrity; the consuming protocol decides authority
|
|
41
|
+
and admissibility. No private control/plane dependency is needed downstream.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
export interface LoginOptions {
|
|
2
|
+
baseUrl?: string;
|
|
3
|
+
/**
|
|
4
|
+
When `wallet` is set, audience to use for control-plane calls.
|
|
5
|
+
*/
|
|
6
|
+
controlAudience?: string;
|
|
7
|
+
/**
|
|
8
|
+
When `wallet` is set, derivation offset of the signing account (default `'0'`).
|
|
9
|
+
*/
|
|
10
|
+
offset?: string;
|
|
11
|
+
privateKey?: string;
|
|
12
|
+
token?: string;
|
|
13
|
+
/**
|
|
14
|
+
When `wallet` is set, TTL in seconds for each minted JWT.
|
|
15
|
+
*/
|
|
16
|
+
ttlSeconds?: number;
|
|
17
|
+
/**
|
|
18
|
+
Use the active aries wallet to self-sign JWTs per request.
|
|
19
|
+
*/
|
|
20
|
+
wallet?: boolean;
|
|
21
|
+
}
|
|
22
|
+
/** The control base URL a login targets: `baseUrl`, else `ARIES_DATALAKE_API`, without a trailing slash. */
|
|
23
|
+
export declare function resolveLoginBaseUrl(baseUrl: string | undefined): string | undefined;
|
|
24
|
+
/**
|
|
25
|
+
* Signs in and stores credentials. Resolves to the control base URL the
|
|
26
|
+
* credentials were saved for, or `undefined` when login failed (the failure
|
|
27
|
+
* is printed and `process.exitCode` set).
|
|
28
|
+
*/
|
|
29
|
+
export declare function login(options: LoginOptions): Promise<string | undefined>;
|
|
30
|
+
//# sourceMappingURL=login.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"login.d.ts","sourceRoot":"","sources":["../../../../src/actions/datalake/login.ts"],"names":[],"mappings":"AAOA,MAAM,WAAW,YAAY;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;MAEE;IACF,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;MAEE;IACF,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;MAEE;IACF,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;MAEE;IACF,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAsFD,4GAA4G;AAC5G,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAEnF;AAED;;;;GAIG;AACH,wBAAsB,KAAK,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CA6B9E"}
|