@cubist-labs/cubesigner-sdk 0.3.26 → 0.3.28

package/dist/src/schema_types.d.ts

@@ -0,0 +1,113 @@
+import { MfaPolicy } from "./role";
+import { components } from "./schema";
+import { JsonMap } from "./util";
+type schemas = components["schemas"];
+export type UserInfo = schemas["UserInfo"];
+export type ConfiguredMfa = schemas["ConfiguredMfa"];
+export type RatchetConfig = schemas["RatchetConfig"];
+export type IdentityProof = schemas["IdentityProof"];
+export type TotpInfo = schemas["TotpInfo"];
+export type OidcAuthResponse = schemas["NewSessionResponse"];
+export type ApiAddFidoChallenge = schemas["FidoCreateChallengeResponse"];
+export type ApiMfaFidoChallenge = schemas["FidoAssertChallenge"];
+export type PublicKeyCredentialCreationOptions = schemas["PublicKeyCredentialCreationOptions"];
+export type PublicKeyCredentialRequestOptions = schemas["PublicKeyCredentialRequestOptions"];
+export type PublicKeyCredentialParameters = schemas["PublicKeyCredentialParameters"];
+export type PublicKeyCredentialDescriptor = schemas["PublicKeyCredentialDescriptor"];
+export type AuthenticatorSelectionCriteria = schemas["AuthenticatorSelectionCriteria"];
+export type PublicKeyCredentialUserEntity = schemas["PublicKeyCredentialUserEntity"];
+export type PublicKeyCredential = schemas["PublicKeyCredential"];
+export type OrgInfo = schemas["OrgInfo"];
+export type UserIdInfo = schemas["UserIdInfo"];
+export type UpdateOrgRequest = schemas["UpdateOrgRequest"];
+export type UpdateOrgResponse = schemas["UpdateOrgResponse"];
+export type OidcIdentity = schemas["OIDCIdentity"];
+export type MemberRole = schemas["MemberRole"];
+export type SchemaKeyType = schemas["KeyType"];
+export type ListKeysResponse = schemas["PaginatedListKeysResponse"];
+export type UpdateKeyRequest = schemas["UpdateKeyRequest"];
+export type KeyInfoApi = schemas["KeyInfo"];
+export type KeyInRoleInfo = schemas["KeyInRoleInfo"];
+export type UserInRoleInfo = schemas["UserInRoleInfo"];
+export type KeyTypeApi = schemas["KeyType"];
+export type ListRolesResponse = schemas["PaginatedListRolesResponse"];
+export type ListRoleKeysResponse = schemas["PaginatedListRoleKeysResponse"];
+export type ListRoleUsersResponse = schemas["PaginatedListRoleUsersResponse"];
+export type UpdateRoleRequest = schemas["UpdateRoleRequest"];
+export type KeyWithPoliciesInfo = schemas["KeyInRoleInfo"];
+export type RoleInfo = schemas["RoleInfo"];
+export type SessionInfo = schemas["SessionInfo"];
+export type ClientSessionInfo = schemas["ClientSessionInfo"];
+export type NewSessionResponse = schemas["NewSessionResponse"];
+export type SessionsResponse = schemas["PaginatedSessionsResponse"];
+export type CreateSignerSessionRequest = schemas["CreateTokenRequest"];
+export type RefreshSignerSessionRequest = schemas["AuthData"];
+export type EvmSignRequest = schemas["Eth1SignRequest"];
+export type EvmSignResponse = schemas["Eth1SignResponse"];
+export type Eip191SignRequest = schemas["Eip191SignRequest"];
+export type Eip712SignRequest = schemas["Eip712SignRequest"];
+export type Eip191Or712SignResponse = schemas["Eip191Or712SignResponse"];
+export type Eth2SignRequest = schemas["Eth2SignRequest"];
+export type Eth2SignResponse = schemas["Eth2SignResponse"];
+export type Eth2StakeRequest = schemas["StakeRequest"];
+export type Eth2StakeResponse = schemas["StakeResponse"];
+export type Eth2UnstakeRequest = schemas["UnstakeRequest"];
+export type Eth2UnstakeResponse = schemas["UnstakeResponse"];
+export type BlobSignRequest = schemas["BlobSignRequest"];
+export type BlobSignResponse = schemas["BlobSignResponse"];
+export type BtcSignRequest = schemas["BtcSignRequest"];
+export type BtcSignResponse = schemas["BtcSignResponse"];
+export type SolanaSignRequest = schemas["SolanaSignRequest"];
+export type SolanaSignResponse = schemas["SolanaSignResponse"];
+export type AvaSignRequest = schemas["AvaSignRequest"];
+export type AvaSignResponse = schemas["AvaSignResponse"];
+export type AcceptedResponse = schemas["AcceptedResponse"];
+export type ErrorResponse = schemas["ErrorResponse"];
+export type BtcSignatureKind = schemas["BtcSignatureKind"];
+export type MfaType = schemas["MfaType"];
+export type MfaRequestInfo = schemas["MfaRequestInfo"];
+export type UserExportInitRequest = schemas["UserExportInitRequest"];
+export type UserExportInitResponse = schemas["UserExportInitResponse"];
+export type UserExportCompleteRequest = schemas["UserExportCompleteRequest"];
+export type UserExportCompleteResponse = schemas["UserExportCompleteResponse"];
+export type UserExportListResponse = schemas["PaginatedUserExportListResponse"];
+export type UserExportKeyMaterial = schemas["JsonKeyPackage"];
+export type Empty = schemas["EmptyImpl"];
+/** Options for a new OIDC user */
+export interface CreateOidcUserOptions {
+    /** The role of an OIDC user, default is "Alien" */
+    memberRole?: MemberRole;
+    /** Optional MFA policy to associate with the user account */
+    mfaPolicy?: MfaPolicy;
+}
+/** Ava P- or X-chain transaction */
+export type AvaTx = {
+    P: AvaPChainTx;
+} | {
+    X: AvaXChainTx;
+};
+/** Ava P-chain transaction */
+export type AvaPChainTx = {
+    AddPermissionlessValidator: JsonMap;
+} | {
+    AddSubnetValidator: JsonMap;
+} | {
+    AddValidator: JsonMap;
+} | {
+    CreateChain: JsonMap;
+} | {
+    CreateSubnet: JsonMap;
+} | {
+    Export: JsonMap;
+} | {
+    Import: JsonMap;
+};
+/** Ava X-chain transaction */
+export type AvaXChainTx = {
+    Base: JsonMap;
+} | {
+    Export: JsonMap;
+} | {
+    Import: JsonMap;
+};
+export {};

package/dist/src/schema_types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2NoZW1hX3R5cGVzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3NjaGVtYV90eXBlcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgTWZhUG9saWN5IH0gZnJvbSBcIi4vcm9sZVwiO1xuaW1wb3J0IHsgY29tcG9uZW50cyB9IGZyb20gXCIuL3NjaGVtYVwiO1xuaW1wb3J0IHsgSnNvbk1hcCB9IGZyb20gXCIuL3V0aWxcIjtcblxudHlwZSBzY2hlbWFzID0gY29tcG9uZW50c1tcInNjaGVtYXNcIl07XG5cbmV4cG9ydCB0eXBlIFVzZXJJbmZvID0gc2NoZW1hc1tcIlVzZXJJbmZvXCJdO1xuZXhwb3J0IHR5cGUgQ29uZmlndXJlZE1mYSA9IHNjaGVtYXNbXCJDb25maWd1cmVkTWZhXCJdO1xuZXhwb3J0IHR5cGUgUmF0Y2hldENvbmZpZyA9IHNjaGVtYXNbXCJSYXRjaGV0Q29uZmlnXCJdO1xuZXhwb3J0IHR5cGUgSWRlbnRpdHlQcm9vZiA9IHNjaGVtYXNbXCJJZGVudGl0eVByb29mXCJdO1xuZXhwb3J0IHR5cGUgVG90cEluZm8gPSBzY2hlbWFzW1wiVG90cEluZm9cIl07XG5cbmV4cG9ydCB0eXBlIE9pZGNBdXRoUmVzcG9uc2UgPSBzY2hlbWFzW1wiTmV3U2Vzc2lvblJlc3BvbnNlXCJdO1xuZXhwb3J0IHR5cGUgQXBpQWRkRmlkb0NoYWxsZW5nZSA9IHNjaGVtYXNbXCJGaWRvQ3JlYXRlQ2hhbGxlbmdlUmVzcG9uc2VcIl07XG5leHBvcnQgdHlwZSBBcGlNZmFGaWRvQ2hhbGxlbmdlID0gc2NoZW1hc1tcIkZpZG9Bc3NlcnRDaGFsbGVuZ2VcIl07XG5cbmV4cG9ydCB0eXBlIFB1YmxpY0tleUNyZWRlbnRpYWxDcmVhdGlvbk9wdGlvbnMgPSBzY2hlbWFzW1wiUHVibGljS2V5Q3JlZGVudGlhbENyZWF0aW9uT3B0aW9uc1wiXTtcbmV4cG9ydCB0eXBlIFB1YmxpY0tleUNyZWRlbnRpYWxSZXF1ZXN0T3B0aW9ucyA9IHNjaGVtYXNbXCJQdWJsaWNLZXlDcmVkZW50aWFsUmVxdWVzdE9wdGlvbnNcIl07XG5leHBvcnQgdHlwZSBQdWJsaWNLZXlDcmVkZW50aWFsUGFyYW1ldGVycyA9IHNjaGVtYXNbXCJQdWJsaWNLZXlDcmVkZW50aWFsUGFyYW1ldGVyc1wiXTtcbmV4cG9ydCB0eXBlIFB1YmxpY0tleUNyZWRlbnRpYWxEZXNjcmlwdG9yID0gc2NoZW1hc1tcIlB1YmxpY0tleUNyZWRlbnRpYWxEZXNjcmlwdG9yXCJdO1xuZXhwb3J0IHR5cGUgQXV0aGVudGljYXRvclNlbGVjdGlvbkNyaXRlcmlhID0gc2NoZW1hc1tcIkF1dGhlbnRpY2F0b3JTZWxlY3Rpb25Dcml0ZXJpYVwiXTtcbmV4cG9ydCB0eXBlIFB1YmxpY0tleUNyZWRlbnRpYWxVc2VyRW50aXR5ID0gc2NoZW1hc1tcIlB1YmxpY0tleUNyZWRlbnRpYWxVc2VyRW50aXR5XCJdO1xuZXhwb3J0IHR5cGUgUHVibGljS2V5Q3JlZGVudGlhbCA9IHNjaGVtYXNbXCJQdWJsaWNLZXlDcmVkZW50aWFsXCJdO1xuXG5leHBvcnQgdHlwZSBPcmdJbmZvID0gc2NoZW1hc1tcIk9yZ0luZm9cIl07XG5leHBvcnQgdHlwZSBVc2VySWRJbmZvID0gc2NoZW1hc1tcIlVzZXJJZEluZm9cIl07XG5leHBvcnQgdHlwZSBVcGRhdGVPcmdSZXF1ZXN0ID0gc2NoZW1hc1tcIlVwZGF0ZU9yZ1JlcXVlc3RcIl07XG5leHBvcnQgdHlwZSBVcGRhdGVPcmdSZXNwb25zZSA9IHNjaGVtYXNbXCJVcGRhdGVPcmdSZXNwb25zZVwiXTtcblxuZXhwb3J0IHR5cGUgT2lkY0lkZW50aXR5ID0gc2NoZW1hc1tcIk9JRENJZGVudGl0eVwiXTtcbmV4cG9ydCB0eXBlIE1lbWJlclJvbGUgPSBzY2hlbWFzW1wiTWVtYmVyUm9sZVwiXTtcblxuZXhwb3J0IHR5cGUgU2NoZW1hS2V5VHlwZSA9IHNjaGVtYXNbXCJLZXlUeXBlXCJdO1xuXG5leHBvcnQgdHlwZSBMaXN0S2V5c1Jlc3BvbnNlID0gc2NoZW1hc1tcIlBhZ2luYXRlZExpc3RLZXlzUmVzcG9uc2VcIl07XG5leHBvcnQgdHlwZSBVcGRhdGVLZXlSZXF1ZXN0ID0gc2NoZW1hc1tcIlVwZGF0ZUtleVJlcXVlc3RcIl07XG5leHBvcnQgdHlwZSBLZXlJbmZvQXBpID0gc2NoZW1hc1tcIktleUluZm9cIl07XG5leHBvcnQgdHlwZSBLZXlJblJvbGVJbmZvID0gc2NoZW1hc1tcIktleUluUm9sZUluZm9cIl07XG5leHBvcnQgdHlwZSBVc2VySW5Sb2xlSW5mbyA9IHNjaGVtYXNbXCJVc2VySW5Sb2xlSW5mb1wiXTtcbmV4cG9ydCB0eXBlIEtleVR5cGVBcGkgPSBzY2hlbWFzW1wiS2V5VHlwZVwiXTtcblxuZXhwb3J0IHR5cGUgTGlzdFJvbGVzUmVzcG9uc2UgPSBzY2hlbWFzW1wiUGFnaW5hdGVkTGlzdFJvbGVzUmVzcG9uc2VcIl07XG5leHBvcnQgdHlwZSBMaXN0Um9sZUtleXNSZXNwb25zZSA9IHNjaGVtYXNbXCJQYWdpbmF0ZWRMaXN0Um9sZUtleXNSZXNwb25zZVwiXTtcbmV4cG9ydCB0eXBlIExpc3RSb2xlVXNlcnNSZXNwb25zZSA9IHNjaGVtYXNbXCJQYWdpbmF0ZWRMaXN0Um9sZVVzZXJzUmVzcG9uc2VcIl07XG5leHBvcnQgdHlwZSBVcGRhdGVSb2xlUmVxdWVzdCA9IHNjaGVtYXNbXCJVcGRhdGVSb2xlUmVxdWVzdFwiXTtcbmV4cG9ydCB0eXBlIEtleVdpdGhQb2xpY2llc0luZm8gPSBzY2hlbWFzW1wiS2V5SW5Sb2xlSW5mb1wiXTtcbmV4cG9ydCB0eXBlIFJvbGVJbmZvID0gc2NoZW1hc1tcIlJvbGVJbmZvXCJdO1xuXG5leHBvcnQgdHlwZSBTZXNzaW9uSW5mbyA9IHNjaGVtYXNbXCJTZXNzaW9uSW5mb1wiXTtcbmV4cG9ydCB0eXBlIENsaWVudFNlc3Npb25JbmZvID0gc2NoZW1hc1tcIkNsaWVudFNlc3Npb25JbmZvXCJdO1xuZXhwb3J0IHR5cGUgTmV3U2Vzc2lvblJlc3BvbnNlID0gc2NoZW1hc1tcIk5ld1Nlc3Npb25SZXNwb25zZVwiXTtcbmV4cG9ydCB0eXBlIFNlc3Npb25zUmVzcG9uc2UgPSBzY2hlbWFzW1wiUGFnaW5hdGVkU2Vzc2lvbnNSZXNwb25zZVwiXTtcblxuZXhwb3J0IHR5cGUgQ3JlYXRlU2lnbmVyU2Vzc2lvblJlcXVlc3QgPSBzY2hlbWFzW1wiQ3JlYXRlVG9rZW5SZXF1ZXN0XCJdO1xuZXhwb3J0IHR5cGUgUmVmcmVzaFNpZ25lclNlc3Npb25SZXF1ZXN0ID0gc2NoZW1hc1tcIkF1dGhEYXRhXCJdO1xuXG5leHBvcnQgdHlwZSBFdm1TaWduUmVxdWVzdCA9IHNjaGVtYXNbXCJFdGgxU2lnblJlcXVlc3RcIl07XG5leHBvcnQgdHlwZSBFdm1TaWduUmVzcG9uc2UgPSBzY2hlbWFzW1wiRXRoMVNpZ25SZXNwb25zZVwiXTtcbmV4cG9ydCB0eXBlIEVpcDE5MVNpZ25SZXF1ZXN0ID0gc2NoZW1hc1tcIkVpcDE5MVNpZ25SZXF1ZXN0XCJdO1xuZXhwb3J0IHR5cGUgRWlwNzEyU2lnblJlcXVlc3QgPSBzY2hlbWFzW1wiRWlwNzEyU2lnblJlcXVlc3RcIl07XG5leHBvcnQgdHlwZSBFaXAxOTFPcjcxMlNpZ25SZXNwb25zZSA9IHNjaGVtYXNbXCJFaXAxOTFPcjcxMlNpZ25SZXNwb25zZVwiXTtcbmV4cG9ydCB0eXBlIEV0aDJTaWduUmVxdWVzdCA9IHNjaGVtYXNbXCJFdGgyU2lnblJlcXVlc3RcIl07XG5leHBvcnQgdHlwZSBFdGgyU2lnblJlc3BvbnNlID0gc2NoZW1hc1tcIkV0aDJTaWduUmVzcG9uc2VcIl07XG5leHBvcnQgdHlwZSBFdGgyU3Rha2VSZXF1ZXN0ID0gc2NoZW1hc1tcIlN0YWtlUmVxdWVzdFwiXTtcbmV4cG9ydCB0eXBlIEV0aDJTdGFrZVJlc3BvbnNlID0gc2NoZW1hc1tcIlN0YWtlUmVzcG9uc2VcIl07XG5leHBvcnQgdHlwZSBFdGgyVW5zdGFrZVJlcXVlc3QgPSBzY2hlbWFzW1wiVW5zdGFrZVJlcXVlc3RcIl07XG5leHBvcnQgdHlwZSBFdGgyVW5zdGFrZVJlc3BvbnNlID0gc2NoZW1hc1tcIlVuc3Rha2VSZXNwb25zZVwiXTtcbmV4cG9ydCB0eXBlIEJsb2JTaWduUmVxdWVzdCA9IHNjaGVtYXNbXCJCbG9iU2lnblJlcXVlc3RcIl07XG5leHBvcnQgdHlwZSBCbG9iU2lnblJlc3BvbnNlID0gc2NoZW1hc1tcIkJsb2JTaWduUmVzcG9uc2VcIl07XG5leHBvcnQgdHlwZSBCdGNTaWduUmVxdWVzdCA9IHNjaGVtYXNbXCJCdGNTaWduUmVxdWVzdFwiXTtcbmV4cG9ydCB0eXBlIEJ0Y1NpZ25SZXNwb25zZSA9IHNjaGVtYXNbXCJCdGNTaWduUmVzcG9uc2VcIl07XG5leHBvcnQgdHlwZSBTb2xhbmFTaWduUmVxdWVzdCA9IHNjaGVtYXNbXCJTb2xhbmFTaWduUmVxdWVzdFwiXTtcbmV4cG9ydCB0eXBlIFNvbGFuYVNpZ25SZXNwb25zZSA9IHNjaGVtYXNbXCJTb2xhbmFTaWduUmVzcG9uc2VcIl07XG5leHBvcnQgdHlwZSBBdmFTaWduUmVxdWVzdCA9IHNjaGVtYXNbXCJBdmFTaWduUmVxdWVzdFwiXTtcbmV4cG9ydCB0eXBlIEF2YVNpZ25SZXNwb25zZSA9IHNjaGVtYXNbXCJBdmFTaWduUmVzcG9uc2VcIl07XG5cbmV4cG9ydCB0eXBlIEFjY2VwdGVkUmVzcG9uc2UgPSBzY2hlbWFzW1wiQWNjZXB0ZWRSZXNwb25zZVwiXTtcbmV4cG9ydCB0eXBlIEVycm9yUmVzcG9uc2UgPSBzY2hlbWFzW1wiRXJyb3JSZXNwb25zZVwiXTtcbmV4cG9ydCB0eXBlIEJ0Y1NpZ25hdHVyZUtpbmQgPSBzY2hlbWFzW1wiQnRjU2lnbmF0dXJlS2luZFwiXTtcblxuZXhwb3J0IHR5cGUgTWZhVHlwZSA9IHNjaGVtYXNbXCJNZmFUeXBlXCJdO1xuZXhwb3J0IHR5cGUgTWZhUmVxdWVzdEluZm8gPSBzY2hlbWFzW1wiTWZhUmVxdWVzdEluZm9cIl07XG5cbmV4cG9ydCB0eXBlIFVzZXJFeHBvcnRJbml0UmVxdWVzdCA9IHNjaGVtYXNbXCJVc2VyRXhwb3J0SW5pdFJlcXVlc3RcIl07XG5leHBvcnQgdHlwZSBVc2VyRXhwb3J0SW5pdFJlc3BvbnNlID0gc2NoZW1hc1tcIlVzZXJFeHBvcnRJbml0UmVzcG9uc2VcIl07XG5leHBvcnQgdHlwZSBVc2VyRXhwb3J0Q29tcGxldGVSZXF1ZXN0ID0gc2NoZW1hc1tcIlVzZXJFeHBvcnRDb21wbGV0ZVJlcXVlc3RcIl07XG5leHBvcnQgdHlwZSBVc2VyRXhwb3J0Q29tcGxldGVSZXNwb25zZSA9IHNjaGVtYXNbXCJVc2VyRXhwb3J0Q29tcGxldGVSZXNwb25zZVwiXTtcbmV4cG9ydCB0eXBlIFVzZXJFeHBvcnRMaXN0UmVzcG9uc2UgPSBzY2hlbWFzW1wiUGFnaW5hdGVkVXNlckV4cG9ydExpc3RSZXNwb25zZVwiXTtcbmV4cG9ydCB0eXBlIFVzZXJFeHBvcnRLZXlNYXRlcmlhbCA9IHNjaGVtYXNbXCJKc29uS2V5UGFja2FnZVwiXTtcblxuZXhwb3J0IHR5cGUgRW1wdHkgPSBzY2hlbWFzW1wiRW1wdHlJbXBsXCJdO1xuXG4vKiogT3B0aW9ucyBmb3IgYSBuZXcgT0lEQyB1c2VyICovXG5leHBvcnQgaW50ZXJmYWNlIENyZWF0ZU9pZGNVc2VyT3B0aW9ucyB7XG4gIC8qKiBUaGUgcm9sZSBvZiBhbiBPSURDIHVzZXIsIGRlZmF1bHQgaXMgXCJBbGllblwiICovXG4gIG1lbWJlclJvbGU/OiBNZW1iZXJSb2xlO1xuICAvKiogT3B0aW9uYWwgTUZBIHBvbGljeSB0byBhc3NvY2lhdGUgd2l0aCB0aGUgdXNlciBhY2NvdW50ICovXG4gIG1mYVBvbGljeT86IE1mYVBvbGljeTtcbn1cblxuLyoqIEF2YSBQLSBvciBYLWNoYWluIHRyYW5zYWN0aW9uICovXG5leHBvcnQgdHlwZSBBdmFUeCA9IHsgUDogQXZhUENoYWluVHggfSB8IHsgWDogQXZhWENoYWluVHggfTtcblxuLyoqIEF2YSBQLWNoYWluIHRyYW5zYWN0aW9uICovXG5leHBvcnQgdHlwZSBBdmFQQ2hhaW5UeCA9XG4gIHwgeyBBZGRQZXJtaXNzaW9ubGVzc1ZhbGlkYXRvcjogSnNvbk1hcCB9XG4gIHwgeyBBZGRTdWJuZXRWYWxpZGF0b3I6IEpzb25NYXAgfVxuICB8IHsgQWRkVmFsaWRhdG9yOiBKc29uTWFwIH1cbiAgfCB7IENyZWF0ZUNoYWluOiBKc29uTWFwIH1cbiAgfCB7IENyZWF0ZVN1Ym5ldDogSnNvbk1hcCB9XG4gIHwgeyBFeHBvcnQ6IEpzb25NYXAgfVxuICB8IHsgSW1wb3J0OiBKc29uTWFwIH07XG5cbi8qKiBBdmEgWC1jaGFpbiB0cmFuc2FjdGlvbiAqL1xuZXhwb3J0IHR5cGUgQXZhWENoYWluVHggPSB7IEJhc2U6IEpzb25NYXAgfSB8IHsgRXhwb3J0OiBKc29uTWFwIH0gfCB7IEltcG9ydDogSnNvbk1hcCB9O1xuIl19

package/dist/src/session/session_storage.d.ts

@@ -0,0 +1,47 @@
+/** Interface for storing sessions. */
+export interface SessionStorage<U> {
+    /** Store session information */
+    save(data: U): Promise<void>;
+    /** Retrieve session information */
+    retrieve(): Promise<U>;
+}
+/** Stores session information in memory */
+export declare class MemorySessionStorage<U> implements SessionStorage<U> {
+    #private;
+    /**
+     * Store session information.
+     * @param {U} data The session information to store
+     * @return {Promise<void>}
+     */
+    save(data: U): Promise<void>;
+    /**
+     * Retrieve session information.
+     * @return {Promise<U>} The session information
+     */
+    retrieve(): Promise<U>;
+    /**
+     * Constructor.
+     * @param {U?} data The initial data
+     */
+    constructor(data?: U);
+}
+/** Stores session information in a JSON file */
+export declare class JsonFileSessionStorage<U> implements SessionStorage<U> {
+    #private;
+    /**
+     * Store session information.
+     * @param {U} data The session information to store
+     * @return {Promise<void>}
+     */
+    save(data: U): Promise<void>;
+    /**
+     * Retrieve session information.
+     * @return {Promise<U>} The session information
+     */
+    retrieve(): Promise<U>;
+    /**
+     * Constructor.
+     * @param {string} filePath The file path to use for storage
+     */
+    constructor(filePath: string);
+}

package/dist/src/session/session_storage.js

@@ -0,0 +1,76 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _MemorySessionStorage_data, _JsonFileSessionStorage_filePath;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JsonFileSessionStorage = exports.MemorySessionStorage = void 0;
+const fs_1 = require("fs");
+/** Stores session information in memory */
+class MemorySessionStorage {
+    /**
+     * Store session information.
+     * @param {U} data The session information to store
+     * @return {Promise<void>}
+     */
+    async save(data) {
+        __classPrivateFieldSet(this, _MemorySessionStorage_data, data, "f");
+    }
+    /**
+     * Retrieve session information.
+     * @return {Promise<U>} The session information
+     */
+    async retrieve() {
+        if (!__classPrivateFieldGet(this, _MemorySessionStorage_data, "f")) {
+            throw new Error("Missing session information");
+        }
+        return __classPrivateFieldGet(this, _MemorySessionStorage_data, "f");
+    }
+    /**
+     * Constructor.
+     * @param {U?} data The initial data
+     */
+    constructor(data) {
+        _MemorySessionStorage_data.set(this, void 0);
+        __classPrivateFieldSet(this, _MemorySessionStorage_data, data, "f");
+    }
+}
+exports.MemorySessionStorage = MemorySessionStorage;
+_MemorySessionStorage_data = new WeakMap();
+/** Stores session information in a JSON file */
+class JsonFileSessionStorage {
+    /**
+     * Store session information.
+     * @param {U} data The session information to store
+     * @return {Promise<void>}
+     */
+    async save(data) {
+        await fs_1.promises.writeFile(__classPrivateFieldGet(this, _JsonFileSessionStorage_filePath, "f"), JSON.stringify(data), "utf-8");
+    }
+    /**
+     * Retrieve session information.
+     * @return {Promise<U>} The session information
+     */
+    async retrieve() {
+        return JSON.parse(await fs_1.promises.readFile(__classPrivateFieldGet(this, _JsonFileSessionStorage_filePath, "f"), "utf-8"));
+    }
+    /**
+     * Constructor.
+     * @param {string} filePath The file path to use for storage
+     */
+    constructor(filePath) {
+        _JsonFileSessionStorage_filePath.set(this, void 0);
+        __classPrivateFieldSet(this, _JsonFileSessionStorage_filePath, filePath, "f");
+    }
+}
+exports.JsonFileSessionStorage = JsonFileSessionStorage;
+_JsonFileSessionStorage_filePath = new WeakMap();
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2Vzc2lvbl9zdG9yYWdlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3Nlc3Npb24vc2Vzc2lvbl9zdG9yYWdlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7OztBQUFBLDJCQUFvQztBQVdwQywyQ0FBMkM7QUFDM0MsTUFBYSxvQkFBb0I7SUFHL0I7Ozs7T0FJRztJQUNILEtBQUssQ0FBQyxJQUFJLENBQUMsSUFBTztRQUNoQix1QkFBQSxJQUFJLDhCQUFTLElBQUksTUFBQSxDQUFDO0lBQ3BCLENBQUM7SUFFRDs7O09BR0c7SUFDSCxLQUFLLENBQUMsUUFBUTtRQUNaLElBQUksQ0FBQyx1QkFBQSxJQUFJLGtDQUFNLEVBQUUsQ0FBQztZQUNoQixNQUFNLElBQUksS0FBSyxDQUFDLDZCQUE2QixDQUFDLENBQUM7UUFDakQsQ0FBQztRQUNELE9BQU8sdUJBQUEsSUFBSSxrQ0FBTSxDQUFDO0lBQ3BCLENBQUM7SUFFRDs7O09BR0c7SUFDSCxZQUFZLElBQVE7UUExQnBCLDZDQUFVO1FBMkJSLHVCQUFBLElBQUksOEJBQVMsSUFBSSxNQUFBLENBQUM7SUFDcEIsQ0FBQztDQUNGO0FBOUJELG9EQThCQzs7QUFFRCxnREFBZ0Q7QUFDaEQsTUFBYSxzQkFBc0I7SUFHakM7Ozs7T0FJRztJQUNILEtBQUssQ0FBQyxJQUFJLENBQUMsSUFBTztRQUNoQixNQUFNLGFBQUUsQ0FBQyxTQUFTLENBQUMsdUJBQUEsSUFBSSx3Q0FBVSxFQUFFLElBQUksQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLEVBQUUsT0FBTyxDQUFDLENBQUM7SUFDcEUsQ0FBQztJQUVEOzs7T0FHRztJQUNILEtBQUssQ0FBQyxRQUFRO1FBQ1osT0FBTyxJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sYUFBRSxDQUFDLFFBQVEsQ0FBQyx1QkFBQSxJQUFJLHdDQUFVLEVBQUUsT0FBTyxDQUFDLENBQUMsQ0FBQztJQUNoRSxDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsWUFBWSxRQUFnQjtRQXZCbkIsbURBQWtCO1FBd0J6Qix1QkFBQSxJQUFJLG9DQUFhLFFBQVEsTUFBQSxDQUFDO0lBQzVCLENBQUM7Q0FDRjtBQTNCRCx3REEyQkMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBwcm9taXNlcyBhcyBmcyB9IGZyb20gXCJmc1wiO1xuXG4vKiogSW50ZXJmYWNlIGZvciBzdG9yaW5nIHNlc3Npb25zLiAqL1xuZXhwb3J0IGludGVyZmFjZSBTZXNzaW9uU3RvcmFnZTxVPiB7XG4gIC8qKiBTdG9yZSBzZXNzaW9uIGluZm9ybWF0aW9uICovXG4gIHNhdmUoZGF0YTogVSk6IFByb21pc2U8dm9pZD47XG5cbiAgLyoqIFJldHJpZXZlIHNlc3Npb24gaW5mb3JtYXRpb24gKi9cbiAgcmV0cmlldmUoKTogUHJvbWlzZTxVPjtcbn1cblxuLyoqIFN0b3JlcyBzZXNzaW9uIGluZm9ybWF0aW9uIGluIG1lbW9yeSAqL1xuZXhwb3J0IGNsYXNzIE1lbW9yeVNlc3Npb25TdG9yYWdlPFU+IGltcGxlbWVudHMgU2Vzc2lvblN0b3JhZ2U8VT4ge1xuICAjZGF0YT86IFU7XG5cbiAgLyoqXG4gICAqIFN0b3JlIHNlc3Npb24gaW5mb3JtYXRpb24uXG4gICAqIEBwYXJhbSB7VX0gZGF0YSBUaGUgc2Vzc2lvbiBpbmZvcm1hdGlvbiB0byBzdG9yZVxuICAgKiBAcmV0dXJuIHtQcm9taXNlPHZvaWQ+fVxuICAgKi9cbiAgYXN5bmMgc2F2ZShkYXRhOiBVKTogUHJvbWlzZTx2b2lkPiB7XG4gICAgdGhpcy4jZGF0YSA9IGRhdGE7XG4gIH1cblxuICAvKipcbiAgICogUmV0cmlldmUgc2Vzc2lvbiBpbmZvcm1hdGlvbi5cbiAgICogQHJldHVybiB7UHJvbWlzZTxVPn0gVGhlIHNlc3Npb24gaW5mb3JtYXRpb25cbiAgICovXG4gIGFzeW5jIHJldHJpZXZlKCk6IFByb21pc2U8VT4ge1xuICAgIGlmICghdGhpcy4jZGF0YSkge1xuICAgICAgdGhyb3cgbmV3IEVycm9yKFwiTWlzc2luZyBzZXNzaW9uIGluZm9ybWF0aW9uXCIpO1xuICAgIH1cbiAgICByZXR1cm4gdGhpcy4jZGF0YTtcbiAgfVxuXG4gIC8qKlxuICAgKiBDb25zdHJ1Y3Rvci5cbiAgICogQHBhcmFtIHtVP30gZGF0YSBUaGUgaW5pdGlhbCBkYXRhXG4gICAqL1xuICBjb25zdHJ1Y3RvcihkYXRhPzogVSkge1xuICAgIHRoaXMuI2RhdGEgPSBkYXRhO1xuICB9XG59XG5cbi8qKiBTdG9yZXMgc2Vzc2lvbiBpbmZvcm1hdGlvbiBpbiBhIEpTT04gZmlsZSAqL1xuZXhwb3J0IGNsYXNzIEpzb25GaWxlU2Vzc2lvblN0b3JhZ2U8VT4gaW1wbGVtZW50cyBTZXNzaW9uU3RvcmFnZTxVPiB7XG4gIHJlYWRvbmx5ICNmaWxlUGF0aDogc3RyaW5nO1xuXG4gIC8qKlxuICAgKiBTdG9yZSBzZXNzaW9uIGluZm9ybWF0aW9uLlxuICAgKiBAcGFyYW0ge1V9IGRhdGEgVGhlIHNlc3Npb24gaW5mb3JtYXRpb24gdG8gc3RvcmVcbiAgICogQHJldHVybiB7UHJvbWlzZTx2b2lkPn1cbiAgICovXG4gIGFzeW5jIHNhdmUoZGF0YTogVSk6IFByb21pc2U8dm9pZD4ge1xuICAgIGF3YWl0IGZzLndyaXRlRmlsZSh0aGlzLiNmaWxlUGF0aCwgSlNPTi5zdHJpbmdpZnkoZGF0YSksIFwidXRmLThcIik7XG4gIH1cblxuICAvKipcbiAgICogUmV0cmlldmUgc2Vzc2lvbiBpbmZvcm1hdGlvbi5cbiAgICogQHJldHVybiB7UHJvbWlzZTxVPn0gVGhlIHNlc3Npb24gaW5mb3JtYXRpb25cbiAgICovXG4gIGFzeW5jIHJldHJpZXZlKCk6IFByb21pc2U8VT4ge1xuICAgIHJldHVybiBKU09OLnBhcnNlKGF3YWl0IGZzLnJlYWRGaWxlKHRoaXMuI2ZpbGVQYXRoLCBcInV0Zi04XCIpKTtcbiAgfVxuXG4gIC8qKlxuICAgKiBDb25zdHJ1Y3Rvci5cbiAgICogQHBhcmFtIHtzdHJpbmd9IGZpbGVQYXRoIFRoZSBmaWxlIHBhdGggdG8gdXNlIGZvciBzdG9yYWdlXG4gICAqL1xuICBjb25zdHJ1Y3RvcihmaWxlUGF0aDogc3RyaW5nKSB7XG4gICAgdGhpcy4jZmlsZVBhdGggPSBmaWxlUGF0aDtcbiAgfVxufVxuIl19

package/dist/src/session/signer_session_manager.d.ts

@@ -0,0 +1,125 @@
+import { Events } from "../events";
+import { EnvInterface } from "../env";
+import { Client } from "../api";
+import { SessionStorage } from "./session_storage";
+import { ClientSessionInfo, NewSessionResponse } from "../schema_types";
+import { operations } from "../schema";
+/** JSON representation of our "signer session" file format */
+export interface SignerSessionData {
+    /** The organization ID */
+    org_id: string;
+    /** The role ID */
+    role_id?: string;
+    /** The purpose of the session token */
+    purpose?: string;
+    /** The token to include in Authorization header */
+    token: string;
+    /** Session info */
+    session_info: ClientSessionInfo;
+    /** Session expiration (in seconds since UNIX epoch) beyond which it cannot be refreshed */
+    session_exp: number | undefined;
+    /** The environment */
+    env: {
+        ["Dev-CubeSignerStack"]: EnvInterface;
+    };
+}
+/** Type of storage required for signer sessions */
+export type SignerSessionStorage = SessionStorage<SignerSessionData>;
+export interface SignerSessionLifetime {
+    /** Session lifetime (in seconds). Defaults to one week (604800). */
+    session?: number;
+    /** Auth token lifetime (in seconds). Defaults to five minutes (300). */
+    auth: number;
+    /** Refresh token lifetime (in seconds). Defaults to one day (86400). */
+    refresh?: number;
+    /** Grace lifetime (in seconds). Defaults to 30 seconds (30). */
+    grace?: number;
+}
+/** Generic session manager interface. */
+export declare class SignerSessionManager {
+    #private;
+    readonly env: EnvInterface;
+    readonly orgId: string;
+    readonly storage: SignerSessionStorage;
+    readonly events: Events;
+    /**
+     * @return {string} The current auth token.
+     * @internal
+     */
+    token(): Promise<string>;
+    /**
+     * Refreshes the current session if needed, then returns a client using the current session.
+     *
+     * May **UPDATE/MUTATE** self.
+     *
+     * @param {operations} operation The operation that this client will be
+     *   used for. This parameter is used exclusively for more accurate error
+     *   reporting and does not affect functionality.
+     * @return {Client} The client with the current session
+     */
+    client(operation?: keyof operations): Promise<Client>;
+    /** Revokes the session. */
+    revoke(): Promise<void>;
+    /**
+     * Refreshes the session and **UPDATES/MUTATES** self.
+     */
+    refresh(): Promise<void>;
+    /**
+     * Returns whether it's time to refresh this token.
+     * @return {boolean} Whether it's time to refresh this token.
+     * @internal
+     */
+    isStale(): Promise<boolean>;
+    /**
+     * Return whether this session has expired and cannot be refreshed anymore.
+     * @return {boolean} Whether this session has expired.
+     * @internal
+     */
+    hasExpired(): boolean;
+    /**
+     * Refreshes the session if it is about to expire.
+     * @return {boolean} Whether the session token was refreshed.
+     * @internal
+     */
+    refreshIfNeeded(): Promise<boolean>;
+    /**
+     * Automatically refreshes the session in the background (if needed) every
+     * minute. This is a simple wrapper around `setInterval`.
+     * @return {number} The interval ID of the refresh timer.
+     */
+    autoRefresh(): RefreshId;
+    /**
+     * Clears the auto refresh timer.
+     * @param {number} timer The timer ID to clear.
+     */
+    clearAutoRefresh(timer: RefreshId): void;
+    /**
+     * @param {EnvInterface} env The CubeSigner environment
+     * @param {string} orgId The organization ID
+     * @param {NewSessionResponse} session The session information.
+     * @param {SignerSessionStorage} storage The storage to use for saving the session.
+     * @return {Promise<SignerSessionManager>} New signer session manager.
+     */
+    static createFromSessionInfo(env: EnvInterface, orgId: string, session: NewSessionResponse, storage?: SignerSessionStorage): Promise<SignerSessionManager>;
+    /**
+     * @param {SignerSessionData} sessionData The session information.
+     * @param {SignerSessionStorage} storage The storage to use for saving the session.
+     * @return {Promise<SignerSessionManager>} New signer session manager.
+     */
+    static createFromSessionData(sessionData: SignerSessionData, storage?: SignerSessionStorage): Promise<SignerSessionManager>;
+    /**
+     * Uses an existing session to create a new signer session manager.
+     *
+     * @param {SignerSessionStorage} storage The session storage to use
+     * @return {Promise<SingerSession>} New signer session manager
+     */
+    static loadFromStorage(storage: SignerSessionStorage): Promise<SignerSessionManager>;
+    /**
+     * Constructor.
+     * @param {SignerSessionData} sessionData Session data
+     * @param {SignerSessionStorage} storage The session storage to use.
+     */
+    constructor(sessionData: SignerSessionData, storage: SignerSessionStorage);
+}
+/** Type of the refresh timer ID. */
+export type RefreshId = ReturnType<typeof setInterval>;