euclid-ndk 0.2.0

package/dist/dto/eam.d.ts

@@ -0,0 +1,105 @@
+/**
+ * The shapes EAM sends back.
+ *
+ * Interfaces and the functions that parse them, rather than untyped objects, so a typo in a field
+ * name is a compile error here instead of an `undefined` that travels. Each parse is defensive -
+ * see {@link import("./json.js")}.
+ *
+ * Field names are the server's (`dto/include/euclid/dto/eam`), converted to camelCase where they
+ * differ; where they do not, the JSON name is the one on the wire.
+ */
+/** The caller identity a response echoes back, from the server's `BaseDto`. */
+export interface Metadata {
+    region: string;
+    accountId: string;
+    user: string;
+}
+/** A signing credential. The secret is returned once, at creation, and never again. */
+export interface AccessKey {
+    accessKeyId: string;
+    active: boolean;
+    createdAt: string;
+}
+/** What a user may reach in one account: which namespaces, and whether they administer it. */
+export interface AccountGrant {
+    accountId: string;
+    namespaces: string[];
+    isAdmin: boolean;
+    granted: string;
+}
+/** A user. `password` is a hash when the server sends one at all - never the plaintext. */
+export interface User {
+    userId: string;
+    ern: string;
+    password: string;
+    email: string;
+    accountId: string;
+    region: string;
+    accountGrants: AccountGrant[];
+    created: string;
+    modified: string;
+}
+/** A named set of users. Membership in the `administrator` group is what makes an admin. */
+export interface UserGroup {
+    name: string;
+    ern: string;
+    accountId: string;
+    region: string;
+    description: string;
+    userIds: string[];
+    created: string;
+    modified: string;
+}
+/** A tenant. Namespaces live under it, and everything else is scoped by the pair. */
+export interface Account {
+    accountId: string;
+    name: string;
+    ern: string;
+    description: string;
+    created: string;
+    modified: string;
+}
+/** A namespace within an account, unique by name within it. */
+export interface Namespace {
+    accountId: string;
+    name: string;
+    ern: string;
+    description: string;
+    created: string;
+    modified: string;
+}
+/** What `login` answers with: a bearer token and, usually, an access key to sign with. */
+export interface LoginResult {
+    token: string;
+    accessKeyId: string;
+    secretAccessKey: string;
+    createdAt: string;
+    isAdmin: boolean;
+    metadata: Metadata;
+    /** The response as it arrived, for anything a later euclid added that this does not name. */
+    raw: Record<string, unknown>;
+}
+/** One page of something, and how many exist in total. */
+export interface Page<T> {
+    total: number;
+    items: T[];
+}
+/** A newly created access key. This is the only time the secret is ever returned. */
+export interface CreateAccessKeyResult {
+    accessKeyId: string;
+    secretAccessKey: string;
+    createdAt: string;
+    metadata: Metadata;
+}
+export declare function toMetadata(document: unknown): Metadata;
+export declare function toAccessKey(document: unknown): AccessKey;
+export declare function toAccountGrant(document: unknown): AccountGrant;
+export declare function toUser(document: unknown): User;
+export declare function toUserGroup(document: unknown): UserGroup;
+export declare function toAccount(document: unknown): Account;
+export declare function toNamespace(document: unknown): Namespace;
+export declare function toLoginResult(document: unknown): LoginResult;
+export declare function toCreateAccessKeyResult(document: unknown): CreateAccessKeyResult;
+/** One page of whatever a listing returns, under the field the server puts it in. */
+export declare function toPage<T>(document: unknown, field: string, parse: (entry: unknown) => T): Page<T>;
+//# sourceMappingURL=eam.d.ts.map

package/dist/dto/eam.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eam.d.ts","sourceRoot":"","sources":["../../src/dto/eam.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAIH,+EAA+E;AAC/E,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,uFAAuF;AACvF,MAAM,WAAW,SAAS;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,8FAA8F;AAC9F,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,2FAA2F;AAC3F,MAAM,WAAW,IAAI;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,4FAA4F;AAC5F,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,qFAAqF;AACrF,MAAM,WAAW,OAAO;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,+DAA+D;AAC/D,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,0FAA0F;AAC1F,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;IACnB,6FAA6F;IAC7F,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC9B;AAED,0DAA0D;AAC1D,MAAM,WAAW,IAAI,CAAC,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,CAAC,EAAE,CAAC;CACZ;AAED,qFAAqF;AACrF,MAAM,WAAW,qBAAqB;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED,wBAAgB,UAAU,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAEtD;AAED,wBAAgB,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAMxD;AAED,wBAAgB,cAAc,CAAC,QAAQ,EAAE,OAAO,GAAG,YAAY,CAO9D;AAED,wBAAgB,MAAM,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI,CAY9C;AAED,wBAAgB,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAWxD;AAED,wBAAgB,SAAS,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CASpD;AAED,wBAAgB,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CASxD;AAED,wBAAgB,aAAa,CAAC,QAAQ,EAAE,OAAO,GAAG,WAAW,CAU5D;AAED,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,OAAO,GAAG,qBAAqB,CAOhF;AAED,qFAAqF;AACrF,wBAAgB,MAAM,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAEjG"}

package/dist/dto/eam.js

@@ -0,0 +1,98 @@
+/**
+ * The shapes EAM sends back.
+ *
+ * Interfaces and the functions that parse them, rather than untyped objects, so a typo in a field
+ * name is a compile error here instead of an `undefined` that travels. Each parse is defensive -
+ * see {@link import("./json.js")}.
+ *
+ * Field names are the server's (`dto/include/euclid/dto/eam`), converted to camelCase where they
+ * differ; where they do not, the JSON name is the one on the wire.
+ */
+import { documents, flag, number, object, strings, text } from "./json.js";
+export function toMetadata(document) {
+    return { region: text(document, "region"), accountId: text(document, "accountId"), user: text(document, "user") };
+}
+export function toAccessKey(document) {
+    return {
+        accessKeyId: text(document, "accessKeyId"),
+        active: flag(document, "active", true),
+        createdAt: text(document, "createdAt"),
+    };
+}
+export function toAccountGrant(document) {
+    return {
+        accountId: text(document, "accountId"),
+        namespaces: strings(document, "namespaces"),
+        isAdmin: flag(document, "isAdmin"),
+        granted: text(document, "granted"),
+    };
+}
+export function toUser(document) {
+    return {
+        userId: text(document, "userId"),
+        ern: text(document, "ern"),
+        password: text(document, "password"),
+        email: text(document, "email"),
+        accountId: text(document, "accountId"),
+        region: text(document, "region"),
+        accountGrants: documents(document, "accountGrants").map(toAccountGrant),
+        created: text(document, "created"),
+        modified: text(document, "modified"),
+    };
+}
+export function toUserGroup(document) {
+    return {
+        name: text(document, "name"),
+        ern: text(document, "ern"),
+        accountId: text(document, "accountId"),
+        region: text(document, "region"),
+        description: text(document, "description"),
+        userIds: strings(document, "userIds"),
+        created: text(document, "created"),
+        modified: text(document, "modified"),
+    };
+}
+export function toAccount(document) {
+    return {
+        accountId: text(document, "accountId"),
+        name: text(document, "name"),
+        ern: text(document, "ern"),
+        description: text(document, "description"),
+        created: text(document, "created"),
+        modified: text(document, "modified"),
+    };
+}
+export function toNamespace(document) {
+    return {
+        accountId: text(document, "accountId"),
+        name: text(document, "name"),
+        ern: text(document, "ern"),
+        description: text(document, "description"),
+        created: text(document, "created"),
+        modified: text(document, "modified"),
+    };
+}
+export function toLoginResult(document) {
+    return {
+        token: text(document, "token"),
+        accessKeyId: text(document, "accessKeyId"),
+        secretAccessKey: text(document, "secretAccessKey"),
+        createdAt: text(document, "createdAt"),
+        isAdmin: flag(document, "isAdmin"),
+        metadata: toMetadata(object(document)["metadata"]),
+        raw: object(document),
+    };
+}
+export function toCreateAccessKeyResult(document) {
+    return {
+        accessKeyId: text(document, "accessKeyId"),
+        secretAccessKey: text(document, "secretAccessKey"),
+        createdAt: text(document, "createdAt"),
+        metadata: toMetadata(object(document)["metadata"]),
+    };
+}
+/** One page of whatever a listing returns, under the field the server puts it in. */
+export function toPage(document, field, parse) {
+    return { total: number(document, "total"), items: documents(document, field).map(parse) };
+}
+//# sourceMappingURL=eam.js.map

package/dist/dto/eam.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eam.js","sourceRoot":"","sources":["../../src/dto/eam.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AA+F3E,MAAM,UAAU,UAAU,CAAC,QAAiB;IAC1C,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC;AACpH,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,QAAiB;IAC3C,OAAO;QACL,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC;QAC1C,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC;QACtC,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC;KACvC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,QAAiB;IAC9C,OAAO;QACL,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC;QACtC,UAAU,EAAE,OAAO,CAAC,QAAQ,EAAE,YAAY,CAAC;QAC3C,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC;QAClC,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC;KACnC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,QAAiB;IACtC,OAAO;QACL,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAChC,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC;QACpC,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC;QAC9B,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC;QACtC,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAChC,aAAa,EAAE,SAAS,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC;QACvE,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC;QAClC,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC;KACrC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,QAAiB;IAC3C,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC5B,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC;QACtC,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAChC,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC;QAC1C,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,SAAS,CAAC;QACrC,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC;QAClC,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC;KACrC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,QAAiB;IACzC,OAAO;QACL,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC;QACtC,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC5B,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC;QAC1C,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC;QAClC,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC;KACrC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,QAAiB;IAC3C,OAAO;QACL,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC;QACtC,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC5B,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC;QAC1C,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC;QAClC,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC;KACrC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,QAAiB;IAC7C,OAAO;QACL,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC;QAC9B,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC;QAC1C,eAAe,EAAE,IAAI,CAAC,QAAQ,EAAE,iBAAiB,CAAC;QAClD,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC;QACtC,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC;QAClC,QAAQ,EAAE,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,CAAC;QAClD,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC;KACtB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,QAAiB;IACvD,OAAO;QACL,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC;QAC1C,eAAe,EAAE,IAAI,CAAC,QAAQ,EAAE,iBAAiB,CAAC;QAClD,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC;QACtC,QAAQ,EAAE,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,CAAC;KACnD,CAAC;AACJ,CAAC;AAED,qFAAqF;AACrF,MAAM,UAAU,MAAM,CAAI,QAAiB,EAAE,KAAa,EAAE,KAA4B;IACtF,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;AAC5F,CAAC"}

package/dist/dto/eap.d.ts

@@ -0,0 +1,88 @@
+/**
+ * The shapes EAP sends back.
+ *
+ * Parsed the same defensive way as every other module's, and on this module the field names are worth
+ * reading twice: a request and the response to it call some of the same things by different names. An
+ * application is deployed from a `bucket` and an `artifact`, and comes back describing a
+ * {@link Application.bucketErn} and an {@link Application.artifactKey}. Names are what an operator has
+ * in hand; ERNs are what euclid stores, and the server resolves the one into the other.
+ */
+/**
+ * One running instance of an application, and where it can be reached.
+ *
+ * A pool's instances are started and stopped as it grows and shrinks, and each is given a port of its
+ * own when it starts - so this is a snapshot rather than a setting.
+ */
+export interface Endpoint {
+    instanceId: string;
+    pid: number;
+    httpPort: number;
+}
+/**
+ * A deployed application: what euclid runs, as what, and how much of it.
+ *
+ * `desiredState` is what somebody asked for - see
+ * {@link import("../modules/eap.js").EuclidEap.startApplication} - and `state` is what is actually
+ * running, which is `RUNNING` exactly when at least one instance answers. The two differing is the
+ * ordinary picture of an application starting up, and the lasting picture of one that cannot.
+ *
+ * `userId` is the identity the application runs as. Unless one was named at deployment it is a technical
+ * principal euclid made for it - no password, no login, one access key - so that nothing an application
+ * leaks is a person's credential.
+ */
+export interface Application {
+    applicationId: string;
+    ern: string;
+    accountId: string;
+    region: string;
+    /** `JAVA`, `PYTHON`, `NODEJS` or `BINARY` - see {@link import("../modules/eap.js")}. */
+    runtime: string;
+    /** The bucket the artifact was deployed from, as an ERN. Deployed by name. */
+    bucketErn: string;
+    /** The object key of the artifact within that bucket. */
+    artifactKey: string;
+    version: string;
+    /**
+     * ESM's checksum of the artifact - the same hash the manager compares the copy on the host against,
+     * and the one a redeploy has to differ from.
+     */
+    md5Sum: string;
+    command: string;
+    arguments: string[];
+    environment: Record<string, string>;
+    /**
+     * The ERNs of the buckets and queues this application was granted, resolved from the names it was
+     * deployed with.
+     */
+    resources: string[];
+    userId: string;
+    /** The level this application logs at, or empty when it is under the configured default. */
+    logLevel: string;
+    minInstances: number;
+    maxInstances: number;
+    readyTimeoutMs: number;
+    /** `RUNNING` or `STOPPED`, as asked for. */
+    desiredState: string;
+    /** `RUNNING` or `STOPPED`, as observed - which is not the same as having been started. */
+    state: string;
+    /** How many instances are running - the length of {@link endpoints}. */
+    instances: number;
+    endpoints: Endpoint[];
+    created: string;
+    modified: string;
+}
+/**
+ * What an application logs at now, and the channel it logs on.
+ *
+ * An empty `logLevel` means the level was taken back rather than changed: the application is under
+ * whatever the installation's logging configuration says again.
+ */
+export interface LogLevelResult {
+    applicationId: string;
+    logLevel: string;
+    channel: string;
+}
+export declare function toEndpoint(document: unknown): Endpoint;
+export declare function toApplication(document: unknown): Application;
+export declare function toLogLevelResult(document: unknown): LogLevelResult;
+//# sourceMappingURL=eap.d.ts.map

package/dist/dto/eap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eap.d.ts","sourceRoot":"","sources":["../../src/dto/eap.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,WAAW;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,wFAAwF;IACxF,OAAO,EAAE,MAAM,CAAC;IAChB,8EAA8E;IAC9E,SAAS,EAAE,MAAM,CAAC;IAClB,yDAAyD;IACzD,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC;;;OAGG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,4FAA4F;IAC5F,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,4CAA4C;IAC5C,YAAY,EAAE,MAAM,CAAC;IACrB,0FAA0F;IAC1F,KAAK,EAAE,MAAM,CAAC;IACd,wEAAwE;IACxE,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,QAAQ,EAAE,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAID,wBAAgB,UAAU,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAMtD;AAED,wBAAgB,aAAa,CAAC,QAAQ,EAAE,OAAO,GAAG,WAAW,CA2B5D;AAED,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,OAAO,GAAG,cAAc,CAMlE"}

package/dist/dto/eap.js

@@ -0,0 +1,54 @@
+/**
+ * The shapes EAP sends back.
+ *
+ * Parsed the same defensive way as every other module's, and on this module the field names are worth
+ * reading twice: a request and the response to it call some of the same things by different names. An
+ * application is deployed from a `bucket` and an `artifact`, and comes back describing a
+ * {@link Application.bucketErn} and an {@link Application.artifactKey}. Names are what an operator has
+ * in hand; ERNs are what euclid stores, and the server resolves the one into the other.
+ */
+import { documents, number, stringMap, strings, text } from "./json.js";
+// -- parsers ---------------------------------------------------------------------------------------
+export function toEndpoint(document) {
+    return {
+        instanceId: text(document, "instanceId"),
+        pid: number(document, "pid"),
+        httpPort: number(document, "httpPort"),
+    };
+}
+export function toApplication(document) {
+    return {
+        applicationId: text(document, "applicationId"),
+        ern: text(document, "ern"),
+        accountId: text(document, "accountId"),
+        region: text(document, "region"),
+        runtime: text(document, "runtime"),
+        bucketErn: text(document, "bucketErn"),
+        artifactKey: text(document, "artifactKey"),
+        version: text(document, "version"),
+        md5Sum: text(document, "md5Sum"),
+        command: text(document, "command"),
+        arguments: strings(document, "arguments"),
+        environment: stringMap(document, "environment"),
+        resources: strings(document, "resources"),
+        userId: text(document, "userId"),
+        logLevel: text(document, "logLevel"),
+        minInstances: number(document, "minInstances"),
+        maxInstances: number(document, "maxInstances"),
+        readyTimeoutMs: number(document, "readyTimeoutMs"),
+        desiredState: text(document, "desiredState"),
+        state: text(document, "state"),
+        instances: number(document, "instances"),
+        endpoints: documents(document, "endpoints").map(toEndpoint),
+        created: text(document, "created"),
+        modified: text(document, "modified"),
+    };
+}
+export function toLogLevelResult(document) {
+    return {
+        applicationId: text(document, "applicationId"),
+        logLevel: text(document, "logLevel"),
+        channel: text(document, "channel"),
+    };
+}
+//# sourceMappingURL=eap.js.map

package/dist/dto/eap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eap.js","sourceRoot":"","sources":["../../src/dto/eap.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAgFxE,qGAAqG;AAErG,MAAM,UAAU,UAAU,CAAC,QAAiB;IAC1C,OAAO;QACL,UAAU,EAAE,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC;QACxC,GAAG,EAAE,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC5B,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,UAAU,CAAC;KACvC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,QAAiB;IAC7C,OAAO;QACL,aAAa,EAAE,IAAI,CAAC,QAAQ,EAAE,eAAe,CAAC;QAC9C,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC;QACtC,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAChC,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC;QAClC,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC;QACtC,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC;QAC1C,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC;QAClC,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAChC,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC;QAClC,SAAS,EAAE,OAAO,CAAC,QAAQ,EAAE,WAAW,CAAC;QACzC,WAAW,EAAE,SAAS,CAAC,QAAQ,EAAE,aAAa,CAAC;QAC/C,SAAS,EAAE,OAAO,CAAC,QAAQ,EAAE,WAAW,CAAC;QACzC,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAChC,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC;QACpC,YAAY,EAAE,MAAM,CAAC,QAAQ,EAAE,cAAc,CAAC;QAC9C,YAAY,EAAE,MAAM,CAAC,QAAQ,EAAE,cAAc,CAAC;QAC9C,cAAc,EAAE,MAAM,CAAC,QAAQ,EAAE,gBAAgB,CAAC;QAClD,YAAY,EAAE,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC;QAC5C,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC;QAC9B,SAAS,EAAE,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC;QACxC,SAAS,EAAE,SAAS,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC;QAC3D,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC;QAClC,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC;KACrC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,QAAiB;IAChD,OAAO;QACL,aAAa,EAAE,IAAI,CAAC,QAAQ,EAAE,eAAe,CAAC;QAC9C,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC;QACpC,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC;KACnC,CAAC;AACJ,CAAC"}

package/dist/dto/ekm.d.ts

@@ -0,0 +1,109 @@
+/**
+ * The shapes EKM sends back.
+ *
+ * Parsed the same defensive way as every other module's - see {@link import("./json.js")}. Field names
+ * are the server's (`dto/include/euclid/dto/ekm`), converted to camelCase.
+ *
+ * Nothing here carries key material: a key's bytes never leave the server, which is the point of having
+ * a key module rather than a table of keys. What a caller gets is a handle - the key's name to encrypt
+ * with, its ERN to administer - and the description it was given, which is what answers, months later,
+ * whether the key can be deleted.
+ */
+/**
+ * An encryption key, described rather than disclosed.
+ *
+ * `name` is the ID the server minted, and what {@link import("../modules/ekm.js").EuclidEkm.encrypt}
+ * takes; `ern` is what the administrative actions take. The two are not interchangeable, which is the
+ * one thing about EKM worth remembering.
+ */
+export interface Key {
+    name: string;
+    ern: string;
+    description: string;
+    algorithm: string;
+    length: number;
+    /**
+     * `AVAILABLE`, `REVOKED` or `PENDING_DELETION`. Only an available key encrypts; a revoked one and one
+     * scheduled for deletion still decrypt what they wrote.
+     */
+    status: string;
+    tags: Record<string, string>;
+    /** When a key scheduled for deletion goes for good. Empty for a key that is not. */
+    deletionDate: string;
+    created: string;
+    modified: string;
+}
+/**
+ * A stored X.509 certificate.
+ *
+ * `certificate` is the PEM, which is public and comes back. The private key does not: it goes in once
+ * and no action returns it, so there is no field for it here.
+ */
+export interface Certificate {
+    name: string;
+    ern: string;
+    description: string;
+    /** The PEM-encoded certificate. */
+    certificate: string;
+    subject: string;
+    issuer: string;
+    serialNumber: string;
+    fingerprint: string;
+    subjectAltNames: string[];
+    /**
+     * Whether euclid generated and signed this itself, in which case nobody else has vouched for it and a
+     * client still has to be told to trust it.
+     */
+    generated: boolean;
+    notBefore: string;
+    notAfter: string;
+    tags: Record<string, string>;
+    created: string;
+    modified: string;
+}
+/** A newly created key. `name` is the ID the server minted - the only handle to it. */
+export interface CreateKeyResult {
+    name: string;
+    ern: string;
+    description: string;
+    algorithm: string;
+    length: number;
+    status: string;
+}
+/**
+ * A key scheduled for deletion, and the date it goes for good.
+ *
+ * Scheduled rather than deleted: everything the key encrypted becomes unreadable when that date passes,
+ * and the window is the only chance anybody gets to notice.
+ */
+export interface DeleteKeyResult {
+    name: string;
+    ern: string;
+    deletionDate: string;
+    status: string;
+}
+/** A revoked key: it encrypts nothing further, and still decrypts what it wrote. */
+export interface RevokeKeyResult {
+    name: string;
+    ern: string;
+    status: string;
+}
+/** A key as it now reads. Only the description changed - not the material, and not the life. */
+export interface KeyDescriptionResult {
+    name: string;
+    ern: string;
+    description: string;
+}
+/** The name and ERN of a deleted certificate. */
+export interface DeleteCertificateResult {
+    name: string;
+    ern: string;
+}
+export declare function toKey(document: unknown): Key;
+export declare function toCertificate(document: unknown): Certificate;
+export declare function toCreateKeyResult(document: unknown): CreateKeyResult;
+export declare function toDeleteKeyResult(document: unknown): DeleteKeyResult;
+export declare function toRevokeKeyResult(document: unknown): RevokeKeyResult;
+export declare function toKeyDescriptionResult(document: unknown): KeyDescriptionResult;
+export declare function toDeleteCertificateResult(document: unknown): DeleteCertificateResult;
+//# sourceMappingURL=ekm.d.ts.map

package/dist/dto/ekm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ekm.d.ts","sourceRoot":"","sources":["../../src/dto/ekm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAMH;;;;;;GAMG;AACH,MAAM,WAAW,GAAG;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,oFAAoF;IACpF,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;IACpB,mCAAmC;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAID,uFAAuF;AACvF,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,oFAAoF;AACpF,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,gGAAgG;AAChG,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,iDAAiD;AACjD,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AAID,wBAAgB,KAAK,CAAC,QAAQ,EAAE,OAAO,GAAG,GAAG,CAa5C;AAED,wBAAgB,aAAa,CAAC,QAAQ,EAAE,OAAO,GAAG,WAAW,CAkB5D;AAED,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,OAAO,GAAG,eAAe,CASpE;AAED,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,OAAO,GAAG,eAAe,CAOpE;AAED,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,OAAO,GAAG,eAAe,CAEpE;AAED,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,OAAO,GAAG,oBAAoB,CAM9E;AAED,wBAAgB,yBAAyB,CAAC,QAAQ,EAAE,OAAO,GAAG,uBAAuB,CAEpF"}

package/dist/dto/ekm.js

@@ -0,0 +1,78 @@
+/**
+ * The shapes EKM sends back.
+ *
+ * Parsed the same defensive way as every other module's - see {@link import("./json.js")}. Field names
+ * are the server's (`dto/include/euclid/dto/ekm`), converted to camelCase.
+ *
+ * Nothing here carries key material: a key's bytes never leave the server, which is the point of having
+ * a key module rather than a table of keys. What a caller gets is a handle - the key's name to encrypt
+ * with, its ERN to administer - and the description it was given, which is what answers, months later,
+ * whether the key can be deleted.
+ */
+import { flag, number, stringMap, strings, text } from "./json.js";
+// -- parsers ---------------------------------------------------------------------------------------
+export function toKey(document) {
+    return {
+        name: text(document, "name"),
+        ern: text(document, "ern"),
+        description: text(document, "description"),
+        algorithm: text(document, "algorithm"),
+        length: number(document, "length"),
+        status: text(document, "status"),
+        tags: stringMap(document, "tags"),
+        deletionDate: text(document, "deletionDate"),
+        created: text(document, "created"),
+        modified: text(document, "modified"),
+    };
+}
+export function toCertificate(document) {
+    return {
+        name: text(document, "name"),
+        ern: text(document, "ern"),
+        description: text(document, "description"),
+        certificate: text(document, "certificate"),
+        subject: text(document, "subject"),
+        issuer: text(document, "issuer"),
+        serialNumber: text(document, "serialNumber"),
+        fingerprint: text(document, "fingerprint"),
+        subjectAltNames: strings(document, "subjectAltNames"),
+        generated: flag(document, "generated"),
+        notBefore: text(document, "notBefore"),
+        notAfter: text(document, "notAfter"),
+        tags: stringMap(document, "tags"),
+        created: text(document, "created"),
+        modified: text(document, "modified"),
+    };
+}
+export function toCreateKeyResult(document) {
+    return {
+        name: text(document, "name"),
+        ern: text(document, "ern"),
+        description: text(document, "description"),
+        algorithm: text(document, "algorithm"),
+        length: number(document, "length"),
+        status: text(document, "status"),
+    };
+}
+export function toDeleteKeyResult(document) {
+    return {
+        name: text(document, "name"),
+        ern: text(document, "ern"),
+        deletionDate: text(document, "deletionDate"),
+        status: text(document, "status"),
+    };
+}
+export function toRevokeKeyResult(document) {
+    return { name: text(document, "name"), ern: text(document, "ern"), status: text(document, "status") };
+}
+export function toKeyDescriptionResult(document) {
+    return {
+        name: text(document, "name"),
+        ern: text(document, "ern"),
+        description: text(document, "description"),
+    };
+}
+export function toDeleteCertificateResult(document) {
+    return { name: text(document, "name"), ern: text(document, "ern") };
+}
+//# sourceMappingURL=ekm.js.map

package/dist/dto/ekm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ekm.js","sourceRoot":"","sources":["../../src/dto/ekm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAuGnE,qGAAqG;AAErG,MAAM,UAAU,KAAK,CAAC,QAAiB;IACrC,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC5B,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC;QAC1C,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC;QACtC,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAClC,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAChC,IAAI,EAAE,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC;QACjC,YAAY,EAAE,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC;QAC5C,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC;QAClC,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC;KACrC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,QAAiB;IAC7C,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC5B,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC;QAC1C,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC;QAC1C,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC;QAClC,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAChC,YAAY,EAAE,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC;QAC5C,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC;QAC1C,eAAe,EAAE,OAAO,CAAC,QAAQ,EAAE,iBAAiB,CAAC;QACrD,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC;QACtC,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC;QACtC,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC;QACpC,IAAI,EAAE,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC;QACjC,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC;QAClC,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC;KACrC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,QAAiB;IACjD,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC5B,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC;QAC1C,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC;QACtC,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAClC,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC;KACjC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,QAAiB;IACjD,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC5B,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,YAAY,EAAE,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC;QAC5C,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC;KACjC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,QAAiB;IACjD,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,CAAC;AACxG,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,QAAiB;IACtD,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC5B,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC;KAC3C,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,QAAiB;IACzD,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,CAAC;AACtE,CAAC"}

package/dist/dto/ekv.d.ts

@@ -0,0 +1,73 @@
+/**
+ * The shapes EKV sends back.
+ *
+ * Parsed the same defensive way as every other module's. One thing is not just parsed but rearranged: the
+ * server stores an item's timestamps as two ordinary attributes, `_created` and `_modified`, and
+ * {@link toItem} lifts them out. Leaving them in would mean an item read, changed and written back acquires
+ * two attributes it never had - and since a write replaces rather than merges, they would stick.
+ */
+/** The attributes the server keeps an item's timestamps in, and which {@link toItem} takes back out. */
+export declare const CREATED_ATTRIBUTE = "_created";
+export declare const MODIFIED_ATTRIBUTE = "_modified";
+/**
+ * One stored item: its attributes, and when it was written.
+ *
+ * The attributes are plain values - strings, numbers, booleans, arrays, nested objects - not the tagged
+ * {@link import("./com.js").Variant} that EQS, ENS and ESM attributes use. EKV stores documents rather than
+ * typed attribute maps, and only a table's key attributes have a declared type.
+ *
+ * `attributes` is the object itself, which is what to pass back to
+ * {@link import("../modules/ekv.js").EuclidEkv.putItem} - the timestamps are deliberately not in it.
+ */
+export interface Item {
+    attributes: Record<string, unknown>;
+    created: string;
+    modified: string;
+}
+/**
+ * A table: what it is keyed on, and how many items it holds.
+ *
+ * `sortKey` is empty for a table that has none, which is also what says that
+ * {@link import("../modules/ekv.js").EuclidEkv.query} cannot narrow by sort key on this table.
+ *
+ * `itemCount` is counted rather than looked up, so describing a large table is not free.
+ */
+export interface TableDescription {
+    name: string;
+    ern: string;
+    partitionKey: string;
+    /** `string`, `number` or `binary` - see {@link import("../modules/ekv.js")}. */
+    partitionKeyType: string;
+    sortKey: string;
+    sortKeyType: string;
+    itemCount: number;
+    created: string;
+    modified: string;
+}
+/**
+ * The items of one partition that matched, in the order they were asked for.
+ *
+ * `count` is how many came back rather than how many exist, which is why this is not one of the pages the
+ * rest of this SDK answers listings with: a query knows what it returned and the server does not count the
+ * partition to tell you what it did not.
+ */
+export interface QueryResult {
+    items: Item[];
+    count: number;
+}
+/**
+ * A page of a table's items, and how many the table holds in total.
+ *
+ * `count` is what came back and `total` what there is - the pair a caller pages against.
+ */
+export interface ScanResult {
+    items: Item[];
+    count: number;
+    total: number;
+}
+/** One item, with its two timestamp attributes lifted out of the rest. */
+export declare function toItem(document: unknown): Item;
+export declare function toTableDescription(document: unknown): TableDescription;
+export declare function toQueryResult(document: unknown): QueryResult;
+export declare function toScanResult(document: unknown): ScanResult;
+//# sourceMappingURL=ekv.d.ts.map

package/dist/dto/ekv.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ekv.d.ts","sourceRoot":"","sources":["../../src/dto/ekv.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAIH,wGAAwG;AACxG,eAAO,MAAM,iBAAiB,aAAa,CAAC;AAC5C,eAAO,MAAM,kBAAkB,cAAc,CAAC;AAE9C;;;;;;;;;GASG;AACH,MAAM,WAAW,IAAI;IACnB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;IACrB,gFAAgF;IAChF,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAID,0EAA0E;AAC1E,wBAAgB,MAAM,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI,CAO9C;AAED,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,OAAO,GAAG,gBAAgB,CAYtE;AAED,wBAAgB,aAAa,CAAC,QAAQ,EAAE,OAAO,GAAG,WAAW,CAI5D;AAED,wBAAgB,YAAY,CAAC,QAAQ,EAAE,OAAO,GAAG,UAAU,CAG1D"}