euclid-ndk 0.2.0

package/dist/dto/esm.d.ts

@@ -0,0 +1,192 @@
+/**
+ * The shapes ESM sends back.
+ *
+ * Interfaces and the functions that parse them, exactly as {@link import("./eam.js")} does and for
+ * the same reasons: a typo in a field name is a compile error here rather than an `undefined` that
+ * travels, and every parse is defensive - see {@link import("./json.js")}.
+ *
+ * Field names are the server's (`dto/include/euclid/dto/esm`), converted to camelCase where they
+ * differ; where they do not, the JSON name is the one on the wire. One rename is deliberate: the
+ * server's `async` flag - "the server answered before it had finished" - is `background` here,
+ * because `async` is a reserved word in the contexts that matter and a field nobody can write is
+ * worse than a field spelled differently from the wire.
+ */
+import { type Variant } from "./com.js";
+/** A bucket: a named container of objects, scoped to an account and a namespace. */
+export interface Bucket {
+    name: string;
+    ern: string;
+    owner: string;
+    size: number;
+    objects: number;
+    tags: Record<string, string>;
+    /**
+     * Whether objects written from now on are encrypted at rest. Says nothing about the ones already
+     * stored - see {@link import("../modules/esm.js").EuclidEsm.enableEncryption}.
+     */
+    encrypted: boolean;
+    encryptionKeyErn: string;
+    /** One of euclid's own buckets rather than somebody's. Left out of a listing unless asked for. */
+    internal: boolean;
+    created: string;
+    modified: string;
+}
+/**
+ * One stored object, as a listing describes it.
+ *
+ * `key` is opaque: a bucket has directories only in the sense that keys share a prefix, which is why
+ * listing them is something a caller asks for rather than something that happens.
+ */
+export interface EsmObject {
+    ern: string;
+    bucketErn: string;
+    key: string;
+    size: number;
+    status: string;
+    contentType: string;
+    md5Sum: string;
+    encrypted: boolean;
+    attributes: Record<string, Variant>;
+    created: string;
+    modified: string;
+}
+/** What a subscription delivers: one object event, as the body of an ordinary message. */
+export interface BucketEvent {
+    eventType: string;
+    bucketErn: string;
+    key: string;
+    ern: string;
+    size: number;
+    contentType: string;
+    md5Sum: string;
+}
+/** One user-defined attribute of an object, as the server stored it. */
+export interface ObjectAttribute {
+    ern: string;
+    name: string;
+    value: Variant;
+}
+/** A newly created bucket: its name, and the ERN everything else names it by. */
+export interface CreateBucketResult {
+    name: string;
+    ern: string;
+}
+/**
+ * A renamed bucket, and how much was repointed at it.
+ *
+ * The ERN is new as well as the name, so this is the one later calls have to use - nothing answers to
+ * the old one afterwards.
+ */
+export interface RenameBucketResult {
+    name: string;
+    ern: string;
+    objects: number;
+    subscriptions: number;
+}
+/** A bucket and the flag it now carries. */
+export interface SetBucketInternalResult {
+    ern: string;
+    name: string;
+    internal: boolean;
+}
+/** A purged bucket, and how many objects went. */
+export interface PurgeBucketResult {
+    ern: string;
+    count: number;
+}
+/**
+ * How many keys were asked for and how many objects went.
+ *
+ * The two differ when a key named nothing, which is not an error - it simply was not there to delete
+ * - so a caller that cares compares them. `background` says the server answered before it had
+ * finished, in which case `objects` is what it took on rather than what it removed.
+ */
+export interface DeleteObjectsResult {
+    ern: string;
+    asked: number;
+    objects: number;
+    background: boolean;
+}
+/** The bucket whose objects were re-announced, and how many of them there were. */
+export interface TouchObjectResult {
+    ern: string;
+    bucketName: string;
+    prefix: string;
+    objects: number;
+    background: boolean;
+}
+/**
+ * The key a bucket now encrypts under, and how many objects predate the change.
+ *
+ * Those objects are not re-encrypted and not touched: each one records the key it was written under
+ * and is read back through it. `keyCreated` says the key is new and belongs to EKM from that moment
+ * on - deleting it there is what makes this bucket's objects unrecoverable.
+ */
+export interface EnableEncryptionResult {
+    ern: string;
+    name: string;
+    keyErn: string;
+    keyId: string;
+    algorithm: string;
+    keyCreated: boolean;
+    existingObjects: number;
+}
+/** The key a bucket was encrypting under, and how many objects are still under it. */
+export interface DisableEncryptionResult {
+    ern: string;
+    name: string;
+    previousKeyErn: string;
+    previousKeyId: string;
+    encryptedObjects: number;
+}
+/**
+ * An object as it was stored, which is what both ways of writing one answer with.
+ *
+ * `put-object` and `complete-upload` return the same payload, so a caller that needs the object's ERN
+ * does not have to take the multipart path to get one.
+ */
+export interface StoredObject {
+    ern: string;
+    bucketErn: string;
+    key: string;
+    size: number;
+    status: string;
+    contentType: string;
+    md5Sum: string;
+}
+/** An opened multipart upload: the ID every part of it carries. */
+export interface CreateUploadResult {
+    uploadId: string;
+    bucketErn: string;
+    key: string;
+}
+/**
+ * An opened multipart download, and how large the object turned out to be.
+ *
+ * The size is what says how many parts there are to ask for: unlike an upload, whose source the
+ * caller has already stat'ed, a download's size is not known until the server is asked.
+ */
+export interface CreateDownloadResult {
+    downloadId: string;
+    bucketErn: string;
+    key: string;
+    ern: string;
+    size: number;
+    contentType: string;
+}
+export declare function toBucket(document: unknown): Bucket;
+export declare function toEsmObject(document: unknown): EsmObject;
+export declare function toBucketEvent(document: unknown): BucketEvent;
+export declare function toObjectAttribute(document: unknown): ObjectAttribute;
+export declare function toCreateBucketResult(document: unknown): CreateBucketResult;
+export declare function toRenameBucketResult(document: unknown): RenameBucketResult;
+export declare function toSetBucketInternalResult(document: unknown): SetBucketInternalResult;
+export declare function toPurgeBucketResult(document: unknown): PurgeBucketResult;
+export declare function toDeleteObjectsResult(document: unknown): DeleteObjectsResult;
+export declare function toTouchObjectResult(document: unknown): TouchObjectResult;
+export declare function toEnableEncryptionResult(document: unknown): EnableEncryptionResult;
+export declare function toDisableEncryptionResult(document: unknown): DisableEncryptionResult;
+export declare function toStoredObject(document: unknown): StoredObject;
+export declare function toCreateUploadResult(document: unknown): CreateUploadResult;
+export declare function toCreateDownloadResult(document: unknown): CreateDownloadResult;
+//# sourceMappingURL=esm.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"esm.d.ts","sourceRoot":"","sources":["../../src/dto/esm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAA2B,KAAK,OAAO,EAAE,MAAM,UAAU,CAAC;AAKjE,oFAAoF;AACpF,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;IACzB,kGAAkG;IAClG,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,0FAA0F;AAC1F,MAAM,WAAW,WAAW;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,wEAAwE;AACxE,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,OAAO,CAAC;CAChB;AAID,iFAAiF;AACjF,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,4CAA4C;AAC5C,MAAM,WAAW,uBAAuB;IACtC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,kDAAkD;AAClD,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB;IAClC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,mFAAmF;AACnF,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,OAAO,CAAC;CACrB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,OAAO,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,sFAAsF;AACtF,MAAM,WAAW,uBAAuB;IACtC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,mEAAmE;AACnE,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB;AAID,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,MAAM,CAclD;AAED,wBAAgB,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAcxD;AAED,wBAAgB,aAAa,CAAC,QAAQ,EAAE,OAAO,GAAG,WAAW,CAU5D;AAED,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,OAAO,GAAG,eAAe,CAMpE;AAED,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,OAAO,GAAG,kBAAkB,CAE1E;AAED,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,OAAO,GAAG,kBAAkB,CAO1E;AAED,wBAAgB,yBAAyB,CAAC,QAAQ,EAAE,OAAO,GAAG,uBAAuB,CAEpF;AAED,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,OAAO,GAAG,iBAAiB,CAExE;AAED,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,OAAO,GAAG,mBAAmB,CAO5E;AAED,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,OAAO,GAAG,iBAAiB,CAQxE;AAED,wBAAgB,wBAAwB,CAAC,QAAQ,EAAE,OAAO,GAAG,sBAAsB,CAUlF;AAED,wBAAgB,yBAAyB,CAAC,QAAQ,EAAE,OAAO,GAAG,uBAAuB,CAQpF;AAED,wBAAgB,cAAc,CAAC,QAAQ,EAAE,OAAO,GAAG,YAAY,CAU9D;AAED,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,OAAO,GAAG,kBAAkB,CAM1E;AAED,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,OAAO,GAAG,oBAAoB,CAS9E"}

package/dist/dto/esm.js

@@ -0,0 +1,147 @@
+/**
+ * The shapes ESM sends back.
+ *
+ * Interfaces and the functions that parse them, exactly as {@link import("./eam.js")} does and for
+ * the same reasons: a typo in a field name is a compile error here rather than an `undefined` that
+ * travels, and every parse is defensive - see {@link import("./json.js")}.
+ *
+ * Field names are the server's (`dto/include/euclid/dto/esm`), converted to camelCase where they
+ * differ; where they do not, the JSON name is the one on the wire. One rename is deliberate: the
+ * server's `async` flag - "the server answered before it had finished" - is `background` here,
+ * because `async` is a reserved word in the contexts that matter and a field nobody can write is
+ * worse than a field spelled differently from the wire.
+ */
+import { toVariant, toVariantMap } from "./com.js";
+import { flag, number, object, stringMap, text } from "./json.js";
+// -- parsers ---------------------------------------------------------------------------------------
+export function toBucket(document) {
+    return {
+        name: text(document, "name"),
+        ern: text(document, "ern"),
+        owner: text(document, "owner"),
+        size: number(document, "size"),
+        objects: number(document, "objects"),
+        tags: stringMap(document, "tags"),
+        encrypted: flag(document, "encrypted"),
+        encryptionKeyErn: text(document, "encryptionKeyErn"),
+        internal: flag(document, "internal"),
+        created: text(document, "created"),
+        modified: text(document, "modified"),
+    };
+}
+export function toEsmObject(document) {
+    return {
+        ern: text(document, "ern"),
+        bucketErn: text(document, "bucketErn"),
+        key: text(document, "key"),
+        size: number(document, "size"),
+        status: text(document, "status"),
+        contentType: text(document, "contentType"),
+        md5Sum: text(document, "md5Sum"),
+        encrypted: flag(document, "encrypted"),
+        attributes: toVariantMap(object(document)["attributes"]),
+        created: text(document, "created"),
+        modified: text(document, "modified"),
+    };
+}
+export function toBucketEvent(document) {
+    return {
+        eventType: text(document, "eventType"),
+        bucketErn: text(document, "bucketErn"),
+        key: text(document, "key"),
+        ern: text(document, "ern"),
+        size: number(document, "size"),
+        contentType: text(document, "contentType"),
+        md5Sum: text(document, "md5Sum"),
+    };
+}
+export function toObjectAttribute(document) {
+    return {
+        ern: text(document, "ern"),
+        name: text(document, "name"),
+        value: toVariant(object(document)["value"]),
+    };
+}
+export function toCreateBucketResult(document) {
+    return { name: text(document, "name"), ern: text(document, "ern") };
+}
+export function toRenameBucketResult(document) {
+    return {
+        name: text(document, "name"),
+        ern: text(document, "ern"),
+        objects: number(document, "objects"),
+        subscriptions: number(document, "subscriptions"),
+    };
+}
+export function toSetBucketInternalResult(document) {
+    return { ern: text(document, "ern"), name: text(document, "name"), internal: flag(document, "internal") };
+}
+export function toPurgeBucketResult(document) {
+    return { ern: text(document, "ern"), count: number(document, "count") };
+}
+export function toDeleteObjectsResult(document) {
+    return {
+        ern: text(document, "ern"),
+        asked: number(document, "asked"),
+        objects: number(document, "objects"),
+        background: flag(document, "async"),
+    };
+}
+export function toTouchObjectResult(document) {
+    return {
+        ern: text(document, "ern"),
+        bucketName: text(document, "bucketName"),
+        prefix: text(document, "prefix"),
+        objects: number(document, "objects"),
+        background: flag(document, "async"),
+    };
+}
+export function toEnableEncryptionResult(document) {
+    return {
+        ern: text(document, "ern"),
+        name: text(document, "name"),
+        keyErn: text(document, "keyErn"),
+        keyId: text(document, "keyId"),
+        algorithm: text(document, "algorithm"),
+        keyCreated: flag(document, "keyCreated"),
+        existingObjects: number(document, "existingObjects"),
+    };
+}
+export function toDisableEncryptionResult(document) {
+    return {
+        ern: text(document, "ern"),
+        name: text(document, "name"),
+        previousKeyErn: text(document, "previousKeyErn"),
+        previousKeyId: text(document, "previousKeyId"),
+        encryptedObjects: number(document, "encryptedObjects"),
+    };
+}
+export function toStoredObject(document) {
+    return {
+        ern: text(document, "ern"),
+        bucketErn: text(document, "bucketErn"),
+        key: text(document, "key"),
+        size: number(document, "size"),
+        status: text(document, "status"),
+        contentType: text(document, "contentType"),
+        md5Sum: text(document, "md5Sum"),
+    };
+}
+export function toCreateUploadResult(document) {
+    return {
+        uploadId: text(document, "uploadId"),
+        bucketErn: text(document, "bucketErn"),
+        key: text(document, "key"),
+    };
+}
+export function toCreateDownloadResult(document) {
+    return {
+        downloadId: text(document, "downloadId"),
+        bucketErn: text(document, "bucketErn"),
+        key: text(document, "key"),
+        ern: text(document, "ern"),
+        size: number(document, "size"),
+        contentType: text(document, "contentType"),
+    };
+}
+//# sourceMappingURL=esm.js.map

package/dist/dto/esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"esm.js","sourceRoot":"","sources":["../../src/dto/esm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,SAAS,EAAE,YAAY,EAAgB,MAAM,UAAU,CAAC;AACjE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAuLlE,qGAAqG;AAErG,MAAM,UAAU,QAAQ,CAAC,QAAiB;IACxC,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC5B,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC;QAC9B,IAAI,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC9B,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC;QACpC,IAAI,EAAE,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC;QACjC,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC;QACtC,gBAAgB,EAAE,IAAI,CAAC,QAAQ,EAAE,kBAAkB,CAAC;QACpD,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC;QACpC,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,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC;QACtC,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,IAAI,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC9B,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAChC,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC;QAC1C,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAChC,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC;QACtC,UAAU,EAAE,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,YAAY,CAAC,CAAC;QACxD,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,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC;QACtC,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC;QACtC,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,IAAI,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC9B,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC;QAC1C,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC;KACjC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,QAAiB;IACjD,OAAO;QACL,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC5B,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC;KAC5C,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,QAAiB;IACpD,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,CAAC;AACtE,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,QAAiB;IACpD,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC5B,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC;QACpC,aAAa,EAAE,MAAM,CAAC,QAAQ,EAAE,eAAe,CAAC;KACjD,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,QAAiB;IACzD,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,CAAC;AAC5G,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,QAAiB;IACnD,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,CAAC;AAC1E,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,QAAiB;IACrD,OAAO;QACL,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,KAAK,EAAE,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC;QAChC,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC;QACpC,UAAU,EAAE,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,QAAiB;IACnD,OAAO;QACL,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,UAAU,EAAE,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC;QACxC,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAChC,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC;QACpC,UAAU,EAAE,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,QAAiB;IACxD,OAAO;QACL,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC5B,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAChC,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC;QAC9B,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC;QACtC,UAAU,EAAE,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC;QACxC,eAAe,EAAE,MAAM,CAAC,QAAQ,EAAE,iBAAiB,CAAC;KACrD,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,QAAiB;IACzD,OAAO;QACL,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC5B,cAAc,EAAE,IAAI,CAAC,QAAQ,EAAE,gBAAgB,CAAC;QAChD,aAAa,EAAE,IAAI,CAAC,QAAQ,EAAE,eAAe,CAAC;QAC9C,gBAAgB,EAAE,MAAM,CAAC,QAAQ,EAAE,kBAAkB,CAAC;KACvD,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,QAAiB;IAC9C,OAAO;QACL,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC;QACtC,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,IAAI,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC9B,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAChC,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC;QAC1C,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC;KACjC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,QAAiB;IACpD,OAAO;QACL,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC;QACpC,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC;QACtC,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;KAC3B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,QAAiB;IACtD,OAAO;QACL,UAAU,EAAE,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC;QACxC,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC;QACtC,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC1B,IAAI,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC9B,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC;KAC3C,CAAC;AACJ,CAAC"}

package/dist/dto/ess.d.ts

@@ -0,0 +1,49 @@
+/**
+ * The shapes ESS sends back.
+ *
+ * Parsed the same defensive way as every other module's. One thing is deliberately absent from
+ * {@link Secret}: the value. Every action but `get-secret` answers with a secret's metadata only, so a
+ * listing, a rotation and a tag change can be logged, printed and passed around without any of them being
+ * the thing that leaks it.
+ */
+/**
+ * A secret's metadata: everything about it except what it is.
+ *
+ * `version` is how many times the value has been replaced, and `rotated` when that last happened - which
+ * together are what an audit of "has this been rotated since the incident" actually reads.
+ */
+export interface Secret {
+    name: string;
+    ern: string;
+    description: string;
+    /**
+     * The EKM key the value is encrypted under. Deleting that key there is what makes this secret's value
+     * unrecoverable, whatever ESS still says about it.
+     */
+    encryptionKeyErn: string;
+    version: number;
+    rotated: string;
+    tags: Record<string, string>;
+    created: string;
+    modified: string;
+}
+/**
+ * A secret, decrypted: its value, and the metadata that goes with it.
+ *
+ * The only shape in this SDK that carries a secret's value, and the only action that produces one.
+ * Whatever a caller does with `value`, this object is the point at which the value entered the process -
+ * which is worth knowing when deciding what to log.
+ */
+export interface SecretValue {
+    value: string;
+    secret: Secret;
+}
+/** The name and ERN of a deleted secret. */
+export interface DeleteSecretResult {
+    name: string;
+    ern: string;
+}
+export declare function toSecret(document: unknown): Secret;
+export declare function toSecretValue(document: unknown): SecretValue;
+export declare function toDeleteSecretResult(document: unknown): DeleteSecretResult;
+//# sourceMappingURL=ess.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ess.d.ts","sourceRoot":"","sources":["../../src/dto/ess.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAIH;;;;;GAKG;AACH,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,4CAA4C;AAC5C,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AAID,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,MAAM,CAYlD;AAED,wBAAgB,aAAa,CAAC,QAAQ,EAAE,OAAO,GAAG,WAAW,CAE5D;AAED,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,OAAO,GAAG,kBAAkB,CAE1E"}

package/dist/dto/ess.js

@@ -0,0 +1,30 @@
+/**
+ * The shapes ESS sends back.
+ *
+ * Parsed the same defensive way as every other module's. One thing is deliberately absent from
+ * {@link Secret}: the value. Every action but `get-secret` answers with a secret's metadata only, so a
+ * listing, a rotation and a tag change can be logged, printed and passed around without any of them being
+ * the thing that leaks it.
+ */
+import { number, object, stringMap, text } from "./json.js";
+// -- parsers ---------------------------------------------------------------------------------------
+export function toSecret(document) {
+    return {
+        name: text(document, "name"),
+        ern: text(document, "ern"),
+        description: text(document, "description"),
+        encryptionKeyErn: text(document, "encryptionKeyErn"),
+        version: number(document, "version"),
+        rotated: text(document, "rotated"),
+        tags: stringMap(document, "tags"),
+        created: text(document, "created"),
+        modified: text(document, "modified"),
+    };
+}
+export function toSecretValue(document) {
+    return { value: text(document, "value"), secret: toSecret(object(document)["secret"]) };
+}
+export function toDeleteSecretResult(document) {
+    return { name: text(document, "name"), ern: text(document, "ern") };
+}
+//# sourceMappingURL=ess.js.map

package/dist/dto/ess.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ess.js","sourceRoot":"","sources":["../../src/dto/ess.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AA0C5D,qGAAqG;AAErG,MAAM,UAAU,QAAQ,CAAC,QAAiB;IACxC,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,gBAAgB,EAAE,IAAI,CAAC,QAAQ,EAAE,kBAAkB,CAAC;QACpD,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC;QACpC,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC;QAClC,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,aAAa,CAAC,QAAiB;IAC7C,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;AAC1F,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,QAAiB;IACpD,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/json.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Reading fields out of a server response, defensively.
+ *
+ * Every response type in this package parses the same way: a field the server did not send reads as
+ * an empty string, an empty array or a zero rather than throwing. A client that insisted on a field
+ * being there would break on the release that adds one - the parse would reach a document shaped
+ * slightly differently from the one it was written against - which is the failure mode these
+ * helpers exist to avoid.
+ */
+/** The document as an object, or an empty one when it is anything else. */
+export declare function object(document: unknown): Record<string, unknown>;
+/** A string field, empty when absent or null. */
+export declare function text(document: unknown, name: string): string;
+/** A boolean field, `fallback` when absent or not a boolean. */
+export declare function flag(document: unknown, name: string, fallback?: boolean): boolean;
+/** A number field, zero when absent or not a number. */
+export declare function number(document: unknown, name: string): number;
+/** An array of strings, empty when absent, with anything that is not a string left out. */
+export declare function strings(document: unknown, name: string): string[];
+/** An object of strings - a tag set - empty when absent, with non-string values left out. */
+export declare function stringMap(document: unknown, name: string): Record<string, string>;
+/** An array of sub-documents, empty when absent. The caller parses each one. */
+export declare function documents(document: unknown, name: string): unknown[];
+//# sourceMappingURL=json.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"json.d.ts","sourceRoot":"","sources":["../../src/dto/json.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,2EAA2E;AAC3E,wBAAgB,MAAM,CAAC,QAAQ,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAIjE;AAED,iDAAiD;AACjD,wBAAgB,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAG5D;AAED,gEAAgE;AAChE,wBAAgB,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,UAAQ,GAAG,OAAO,CAG/E;AAED,wDAAwD;AACxD,wBAAgB,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAG9D;AAED,2FAA2F;AAC3F,wBAAgB,OAAO,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAGjE;AAED,6FAA6F;AAC7F,wBAAgB,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAMjF;AAED,gFAAgF;AAChF,wBAAgB,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,EAAE,CAGpE"}

package/dist/dto/json.js

@@ -0,0 +1,47 @@
+/**
+ * Reading fields out of a server response, defensively.
+ *
+ * Every response type in this package parses the same way: a field the server did not send reads as
+ * an empty string, an empty array or a zero rather than throwing. A client that insisted on a field
+ * being there would break on the release that adds one - the parse would reach a document shaped
+ * slightly differently from the one it was written against - which is the failure mode these
+ * helpers exist to avoid.
+ */
+/** The document as an object, or an empty one when it is anything else. */
+export function object(document) {
+    return document !== null && typeof document === "object" && !Array.isArray(document)
+        ? document
+        : {};
+}
+/** A string field, empty when absent or null. */
+export function text(document, name) {
+    const value = object(document)[name];
+    return typeof value === "string" ? value : "";
+}
+/** A boolean field, `fallback` when absent or not a boolean. */
+export function flag(document, name, fallback = false) {
+    const value = object(document)[name];
+    return typeof value === "boolean" ? value : fallback;
+}
+/** A number field, zero when absent or not a number. */
+export function number(document, name) {
+    const value = object(document)[name];
+    return typeof value === "number" && Number.isFinite(value) ? value : 0;
+}
+/** An array of strings, empty when absent, with anything that is not a string left out. */
+export function strings(document, name) {
+    const value = object(document)[name];
+    return Array.isArray(value) ? value.filter((entry) => typeof entry === "string") : [];
+}
+/** An object of strings - a tag set - empty when absent, with non-string values left out. */
+export function stringMap(document, name) {
+    const value = object(document)[name];
+    const entries = Object.entries(object(value)).filter((entry) => typeof entry[1] === "string");
+    return Object.fromEntries(entries);
+}
+/** An array of sub-documents, empty when absent. The caller parses each one. */
+export function documents(document, name) {
+    const value = object(document)[name];
+    return Array.isArray(value) ? value : [];
+}
+//# sourceMappingURL=json.js.map

package/dist/dto/json.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.js","sourceRoot":"","sources":["../../src/dto/json.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,2EAA2E;AAC3E,MAAM,UAAU,MAAM,CAAC,QAAiB;IACtC,OAAO,QAAQ,KAAK,IAAI,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;QAClF,CAAC,CAAE,QAAoC;QACvC,CAAC,CAAC,EAAE,CAAC;AACT,CAAC;AAED,iDAAiD;AACjD,MAAM,UAAU,IAAI,CAAC,QAAiB,EAAE,IAAY;IAClD,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;AAChD,CAAC;AAED,gEAAgE;AAChE,MAAM,UAAU,IAAI,CAAC,QAAiB,EAAE,IAAY,EAAE,QAAQ,GAAG,KAAK;IACpE,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC;IACrC,OAAO,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;AACvD,CAAC;AAED,wDAAwD;AACxD,MAAM,UAAU,MAAM,CAAC,QAAiB,EAAE,IAAY;IACpD,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AACzE,CAAC;AAED,2FAA2F;AAC3F,MAAM,UAAU,OAAO,CAAC,QAAiB,EAAE,IAAY;IACrD,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC;IACrC,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAmB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACzG,CAAC;AAED,6FAA6F;AAC7F,MAAM,UAAU,SAAS,CAAC,QAAiB,EAAE,IAAY;IACvD,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAClD,CAAC,KAAK,EAA6B,EAAE,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,QAAQ,CACnE,CAAC;IACF,OAAO,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AACrC,CAAC;AAED,gFAAgF;AAChF,MAAM,UAAU,SAAS,CAAC,QAAiB,EAAE,IAAY;IACvD,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC;IACrC,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;AAC3C,CAAC"}

package/dist/errors.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Errors this SDK throws.
+ *
+ * The server answers every failure the same way - a non-2xx status and a JSON body of the form
+ * `{"error": "..."}` (`Core::HttpActionServer::ErrorResponse`) - so the message a caller sees is
+ * pulled out of that body when it is there, and falls back to the raw body when it is not.
+ */
+/** Base class for everything this SDK throws. */
+export declare class EuclidError extends Error {
+    constructor(message: string);
+}
+/**
+ * A login was refused.
+ *
+ * Separate from {@link EuclidServiceError} because it is the one failure a caller can nearly always
+ * do something about: the password is wrong, the account is disabled, or the user is a technical
+ * user the server refuses to log in interactively.
+ */
+export declare class EuclidAuthenticationError extends EuclidError {
+    readonly status: number;
+    readonly body: string;
+    /** The server's own message, out of the `{"error": "..."}` body. */
+    readonly reason: string;
+    constructor(status: number, body?: string);
+}
+/**
+ * A module refused or failed an action.
+ *
+ * Carries the target and action alongside the status, so a caller catching one of these knows which
+ * call failed without having to have wrapped each one individually.
+ */
+export declare class EuclidServiceError extends EuclidError {
+    readonly target: string;
+    readonly action: string;
+    readonly status: number;
+    readonly body: string;
+    readonly reason: string;
+    constructor(target: string, action: string, status: number, body?: string);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,iDAAiD;AACjD,qBAAa,WAAY,SAAQ,KAAK;gBACxB,OAAO,EAAE,MAAM;CAI5B;AAED;;;;;;GAMG;AACH,qBAAa,yBAA0B,SAAQ,WAAW;IACxD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,oEAAoE;IACpE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;gBAEZ,MAAM,EAAE,MAAM,EAAE,IAAI,SAAK;CAOtC;AAED;;;;;GAKG;AACH,qBAAa,kBAAmB,SAAQ,WAAW;IACjD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;gBAEZ,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,SAAK;CAStE"}

package/dist/errors.js

@@ -0,0 +1,73 @@
+/**
+ * Errors this SDK throws.
+ *
+ * The server answers every failure the same way - a non-2xx status and a JSON body of the form
+ * `{"error": "..."}` (`Core::HttpActionServer::ErrorResponse`) - so the message a caller sees is
+ * pulled out of that body when it is there, and falls back to the raw body when it is not.
+ */
+/** Base class for everything this SDK throws. */
+export class EuclidError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = new.target.name;
+    }
+}
+/**
+ * A login was refused.
+ *
+ * Separate from {@link EuclidServiceError} because it is the one failure a caller can nearly always
+ * do something about: the password is wrong, the account is disabled, or the user is a technical
+ * user the server refuses to log in interactively.
+ */
+export class EuclidAuthenticationError extends EuclidError {
+    status;
+    body;
+    /** The server's own message, out of the `{"error": "..."}` body. */
+    reason;
+    constructor(status, body = "") {
+        const reason = reasonOf(body);
+        super(`login failed with HTTP ${status}${reason ? `: ${reason}` : ""}`);
+        this.status = status;
+        this.body = body;
+        this.reason = reason;
+    }
+}
+/**
+ * A module refused or failed an action.
+ *
+ * Carries the target and action alongside the status, so a caller catching one of these knows which
+ * call failed without having to have wrapped each one individually.
+ */
+export class EuclidServiceError extends EuclidError {
+    target;
+    action;
+    status;
+    body;
+    reason;
+    constructor(target, action, status, body = "") {
+        const reason = reasonOf(body);
+        super(`${target}/${action} failed with HTTP ${status}${reason ? `: ${reason}` : ""}`);
+        this.target = target;
+        this.action = action;
+        this.status = status;
+        this.body = body;
+        this.reason = reason;
+    }
+}
+/** The server's error message, or the body verbatim when it is not the shape we expect. */
+function reasonOf(body) {
+    if (!body)
+        return "";
+    try {
+        const parsed = JSON.parse(body);
+        if (parsed && typeof parsed === "object" && typeof parsed.error === "string") {
+            return parsed.error;
+        }
+    }
+    catch {
+        // Not JSON at all, which is what a proxy's error page looks like. The body itself is then the
+        // most useful thing there is to say.
+    }
+    return body.trim();
+}
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,iDAAiD;AACjD,MAAM,OAAO,WAAY,SAAQ,KAAK;IACpC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;IAC9B,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,OAAO,yBAA0B,SAAQ,WAAW;IAC/C,MAAM,CAAS;IACf,IAAI,CAAS;IACtB,oEAAoE;IAC3D,MAAM,CAAS;IAExB,YAAY,MAAc,EAAE,IAAI,GAAG,EAAE;QACnC,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC9B,KAAK,CAAC,0BAA0B,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACxE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,kBAAmB,SAAQ,WAAW;IACxC,MAAM,CAAS;IACf,MAAM,CAAS;IACf,MAAM,CAAS;IACf,IAAI,CAAS;IACb,MAAM,CAAS;IAExB,YAAY,MAAc,EAAE,MAAc,EAAE,MAAc,EAAE,IAAI,GAAG,EAAE;QACnE,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC9B,KAAK,CAAC,GAAG,MAAM,IAAI,MAAM,qBAAqB,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACtF,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAED,2FAA2F;AAC3F,SAAS,QAAQ,CAAC,IAAY;IAC5B,IAAI,CAAC,IAAI;QAAE,OAAO,EAAE,CAAC;IACrB,IAAI,CAAC;QACH,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAQ,MAA8B,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;YACtG,OAAQ,MAA4B,CAAC,KAAK,CAAC;QAC7C,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,8FAA8F;QAC9F,qCAAqC;IACvC,CAAC;IACD,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;AACrB,CAAC"}