@1password/sdk 0.2.0 → 0.2.1

package/README.md

@@ -86,7 +86,7 @@ Operations:
 - [x] [Delete items](https://developer.1password.com/docs/sdks/manage-items#delete-an-item)
 - [x] [Archive items](https://developer.1password.com/docs/sdks/manage-items/#archive-an-item)
 - [x] [List items](https://developer.1password.com/docs/sdks/list-vaults-items/)
-- [x] [Share items](https://developer.1password.com/docs/sdks/share-items) (items with files cannot be shared)
+- [x] [Share items](https://developer.1password.com/docs/sdks/share-items)
 - [x] [Generate PIN, random and memorable passwords](https://developer.1password.com/docs/sdks/manage-items#generate-a-password)
 
 Field types:
@@ -104,8 +104,8 @@ Field types:
 - [x] Credit card numbers
 - [x] Emails
 - [x] References to other items
-- [ ] Address
-- [ ] Date
+- [x] Address
+- [x] Date
 - [x] MM/YY
 - [x] Files attachments and Document items
 - [x] Menu

package/dist/configuration.d.ts

@@ -1,6 +1,6 @@
 import { ClientAuthConfig } from "./core.js";
 export declare const LANGUAGE = "JS";
-export declare const VERSION = "0020001";
+export declare const VERSION = "0020101";
 export interface ClientConfiguration {
     auth: Auth;
     integrationName: string;

package/dist/secrets.d.ts

@@ -1,5 +1,5 @@
 import { InnerClient } from "./core.js";
-import { GeneratePasswordResponse, PasswordRecipe } from "./types.js";
+import { GeneratePasswordResponse, PasswordRecipe, ResolveAllResponse } from "./types.js";
 /**
  * The Secrets API includes all operations the SDK client can perform on secrets.
  * Use secret reference URIs to securely load secrets from 1Password: op://<vault-name>/<item-name>[/<section-name>]/<field-name>
@@ -9,6 +9,10 @@ export interface SecretsApi {
      * Resolve returns the secret the provided secret reference points to.
      */
     resolve(secretReference: string): Promise<string>;
+    /**
+     * Resolve takes in a list of secret references and returns the secrets they point to or errors if any.
+     */
+    resolveAll(secretReferences: string[]): Promise<ResolveAllResponse>;
 }
 export declare class Secrets implements SecretsApi {
     #private;
@@ -17,6 +21,10 @@ export declare class Secrets implements SecretsApi {
      * Resolve returns the secret the provided secret reference points to.
      */
     resolve(secretReference: string): Promise<string>;
+    /**
+     * Resolve takes in a list of secret references and returns the secrets they point to or errors if any.
+     */
+    resolveAll(secretReferences: string[]): Promise<ResolveAllResponse>;
     /**
      * Validate the secret reference to ensure there are no syntax errors.
      */

package/dist/secrets.js

@@ -49,6 +49,25 @@ class Secrets {
             return JSON.parse(yield __classPrivateFieldGet(this, _Secrets_inner, "f").core.invoke(invocationConfig), types_js_1.ReviverFunc);
         });
     }
+    /**
+     * Resolve takes in a list of secret references and returns the secrets they point to or errors if any.
+     */
+    resolveAll(secretReferences) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                invocation: {
+                    clientId: __classPrivateFieldGet(this, _Secrets_inner, "f").id,
+                    parameters: {
+                        name: "SecretsResolveAll",
+                        parameters: {
+                            secret_references: secretReferences,
+                        },
+                    },
+                },
+            };
+            return JSON.parse(yield __classPrivateFieldGet(this, _Secrets_inner, "f").core.invoke(invocationConfig), types_js_1.ReviverFunc);
+        });
+    }
     /**
      * Validate the secret reference to ensure there are no syntax errors.
      */

package/dist/types.d.ts

@@ -1,7 +1,21 @@
+export type ErrorMessage = string;
+/** Additional attributes for OTP fields. */
+export interface AddressFieldDetails {
+    /** The street address */
+    street: string;
+    /** The city */
+    city: string;
+    /** The country */
+    country: string;
+    /** The ZIP code */
+    zip: string;
+    /** The state */
+    state: string;
+}
 export interface DocumentCreateParams {
-    /** the name of the file */
+    /** The name of the file */
     name: string;
-    /** the content of the file */
+    /** The content of the file */
     content: Uint8Array;
 }
 export interface FileAttributes {
@@ -13,13 +27,13 @@ export interface FileAttributes {
     size: number;
 }
 export interface FileCreateParams {
-    /** the name of the file */
+    /** The name of the file */
     name: string;
-    /** the content of the file */
+    /** The content of the file */
     content: Uint8Array;
-    /** the section id where the file should be stored */
+    /** The section id where the file should be stored */
     sectionId: string;
-    /** the field id where the file should be stored */
+    /** The field id where the file should be stored */
     fieldId: string;
 }
 /**
@@ -69,6 +83,8 @@ export declare enum ItemFieldType {
     SshKey = "SshKey",
     Menu = "Menu",
     MonthYear = "MonthYear",
+    Address = "Address",
+    Date = "Date",
     Unsupported = "Unsupported"
 }
 /** Field type-specific attributes. */
@@ -82,6 +98,11 @@ export type ItemFieldDetails =
  | {
     type: "SshKey";
     content?: SshKeyAttributes;
+}
+/** Address components */
+ | {
+    type: "Address";
+    content?: AddressFieldDetails;
 };
 /** Represents a field within an item. */
 export interface ItemField {
@@ -165,6 +186,10 @@ export interface Item {
     files: ItemFile[];
     /** The document file for the Document item category */
     document?: FileAttributes;
+    /** The time the item was created at */
+    createdAt: Date;
+    /** The time the item was updated at */
+    updatedAt: Date;
 }
 export interface ItemCreateParams {
     /** The item's category */
@@ -185,10 +210,10 @@ export interface ItemCreateParams {
     websites?: Website[];
     /** The item's files stored as fields */
     files?: FileCreateParams[];
-    /** The document file for the Document item category */
+    /** The document file for the Document item type. Empty when the item isn't of Document type. */
     document?: DocumentCreateParams;
 }
-/** Represents a decrypted 1Password item. */
+/** Represents a decrypted 1Password item overview. */
 export interface ItemOverview {
     /** The item's ID */
     id: string;
@@ -200,6 +225,12 @@ export interface ItemOverview {
     vaultId: string;
     /** The websites used for autofilling for items of the Login and Password categories. */
     websites: Website[];
+    /** The item tags */
+    tags: string[];
+    /** The time the item was created at */
+    createdAt: Date;
+    /** The time the item was updated at */
+    updatedAt: Date;
 }
 /** The valid duration options for sharing an item */
 export declare enum ItemShareDuration {
@@ -228,6 +259,23 @@ export declare enum AllowedRecipientType {
     /** Recipients can be specified by domain */
     Domain = "Domain"
 }
+/** The file sharing policy */
+export interface ItemShareFiles {
+    /** Whether files can be included in item shares */
+    allowed: boolean;
+    /** The maximum encrypted size (in bytes) an included file can be */
+    maxSize: number;
+    /** The allowed types of item sharing - either "Authenticated" (share to specific users) or "Public" (share to anyone with a link) */
+    allowedTypes?: AllowedType[];
+    /** The allowed recipient types of item sharing - either "Email" or "Domain" */
+    allowedRecipientTypes?: AllowedRecipientType[];
+    /** The maximum duration that an item can be shared for */
+    maxExpiry?: ItemShareDuration;
+    /** The default duration that an item is shared for */
+    defaultExpiry?: ItemShareDuration;
+    /** The maximum number of times an item can be viewed. A null value means unlimited views */
+    maxViews?: number;
+}
 /**
  * The account policy for sharing items, set by your account owner/admin
  * This policy is enforced server-side when sharing items
@@ -243,6 +291,8 @@ export interface ItemShareAccountPolicy {
     allowedTypes: AllowedType[];
     /** The allowed recipient types of item sharing - either "Email" or "Domain" */
     allowedRecipientTypes: AllowedRecipientType[];
+    /** The file sharing policy */
+    files: ItemShareFiles;
 }
 /** The validated recipient of an item share */
 export type ValidRecipient = 
@@ -279,6 +329,99 @@ export interface OtpFieldDetails {
     /** The error message, if the OTP code could not be computed */
     errorMessage?: string;
 }
+export interface Response<T, E> {
+    content?: T;
+    error?: E;
+}
+export interface ResolvedReference {
+    secret: string;
+    itemId: string;
+    vaultId: string;
+}
+export type ResolveReferenceError = 
+/** Error parsing the secret reference */
+{
+    type: "parsing";
+    message: ErrorMessage;
+}
+/** The specified reference cannot be found within the item */
+ | {
+    type: "fieldNotFound";
+    message?: undefined;
+}
+/** No vault matched the secret reference query */
+ | {
+    type: "vaultNotFound";
+    message?: undefined;
+}
+/** More than one vault matched the secret reference query */
+ | {
+    type: "tooManyVaults";
+    message?: undefined;
+}
+/** No item matched the secret reference query */
+ | {
+    type: "itemNotFound";
+    message?: undefined;
+}
+/** More than one item matched the secret reference query */
+ | {
+    type: "tooManyItems";
+    message?: undefined;
+}
+/** More than one field matched the provided secret reference */
+ | {
+    type: "tooManyMatchingFields";
+    message?: undefined;
+}
+/** No section found within the item for the provided identifier */
+ | {
+    type: "noMatchingSections";
+    message?: undefined;
+}
+/** Incompatiable TOTP query parameters */
+ | {
+    type: "incompatibleTOTPQueryParameterField";
+    message?: undefined;
+}
+/** The totp was not able to be generated */
+ | {
+    type: "unableToGenerateTotpCode";
+    message: ErrorMessage;
+}
+/** Couldn't find attributes specific to an SSH Key field */
+ | {
+    type: "sSHKeyMetadataNotFound";
+    message?: undefined;
+}
+/** Currently only support text files */
+ | {
+    type: "unsupportedFileFormat";
+    message?: undefined;
+}
+/** Trying to convert a non-private key to a private key format */
+ | {
+    type: "incompatibleSshKeyQueryParameterField";
+    message?: undefined;
+}
+/** Unable to properly parse a private key string to convert to an internal Private Key type */
+ | {
+    type: "unableToParsePrivateKey";
+    message?: undefined;
+}
+/** Unable to format a private key to OpenSSH format */
+ | {
+    type: "unableToFormatPrivateKeyToOpenSsh";
+    message?: undefined;
+}
+/** Other type */
+ | {
+    type: "other";
+    message?: undefined;
+};
+export interface ResolveAllResponse {
+    individualResponses: Record<string, Response<ResolvedReference, ResolveReferenceError>>;
+}
 export interface SshKeyAttributes {
     /** The public part of the SSH Key */
     publicKey: string;
@@ -370,5 +513,11 @@ export declare enum WordListType {
     /** Three (random) letter "words" */
     ThreeLetters = "threeLetters"
 }
+/**
+ * Custom JSON reviver and replacer functions for dynamic data transformation
+ * ReviverFunc is used during JSON parsing to detect and transform specific data structures
+ * ReplacerFunc is used during JSON serialization to modify certain values before stringifying.
+ * These functions allow for flexible encoding and decoding of data, ensuring that complex types are properly handled when converting between TS objects and JSON
+ */
 export declare const ReviverFunc: (key: string, value: unknown) => unknown;
 export declare const ReplacerFunc: (key: string, value: unknown) => unknown;

package/dist/types.js

@@ -45,6 +45,8 @@ var ItemFieldType;
     ItemFieldType["SshKey"] = "SshKey";
     ItemFieldType["Menu"] = "Menu";
     ItemFieldType["MonthYear"] = "MonthYear";
+    ItemFieldType["Address"] = "Address";
+    ItemFieldType["Date"] = "Date";
     ItemFieldType["Unsupported"] = "Unsupported";
 })(ItemFieldType || (exports.ItemFieldType = ItemFieldType = {}));
 /**
@@ -141,7 +143,18 @@ var WordListType;
     /** Three (random) letter "words" */
     WordListType["ThreeLetters"] = "threeLetters";
 })(WordListType || (exports.WordListType = WordListType = {}));
+/**
+ * Custom JSON reviver and replacer functions for dynamic data transformation
+ * ReviverFunc is used during JSON parsing to detect and transform specific data structures
+ * ReplacerFunc is used during JSON serialization to modify certain values before stringifying.
+ * These functions allow for flexible encoding and decoding of data, ensuring that complex types are properly handled when converting between TS objects and JSON
+ */
 const ReviverFunc = (key, value) => {
+    if (typeof value === "string" &&
+        /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z$/.test(value) &&
+        (key === "createdAt" || key === "updatedAt")) {
+        return new Date(value);
+    }
     if (Array.isArray(value) &&
         value.every((v) => Number.isInteger(v) && v >= 0 && v <= 255) &&
         value.length > 0) {
@@ -151,6 +164,9 @@ const ReviverFunc = (key, value) => {
 };
 exports.ReviverFunc = ReviverFunc;
 const ReplacerFunc = (key, value) => {
+    if (value instanceof Date) {
+        return value.toISOString();
+    }
     if (value instanceof Uint8Array) {
         return Array.from(value);
     }

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-export declare const SDK_VERSION = "0.2.0";
-export declare const SDK_BUILD_NUMBER = "0020001";
+export declare const SDK_VERSION = "0.2.1";
+export declare const SDK_BUILD_NUMBER = "0020101";

package/dist/version.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_BUILD_NUMBER = exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.2.0";
-exports.SDK_BUILD_NUMBER = "0020001";
-const SDK_CORE_VERSION = "0.2.0";
+exports.SDK_VERSION = "0.2.1";
+exports.SDK_BUILD_NUMBER = "0020101";
+const SDK_CORE_VERSION = "0.2.1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@1password/sdk",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "The 1Password JavaScript SDK offers programmatic read access to your secrets in 1Password in an interface native to JavaScript. The SDK currently supports `Node.JS`",
   "scripts": {
     "build": "tsc",
@@ -26,7 +26,7 @@
   "main": "./dist/sdk.js",
   "types": "./dist/sdk.d.ts",
   "dependencies": {
-    "@1password/sdk-core": "0.2.0"
+    "@1password/sdk-core": "0.2.1"
   },
   "devDependencies": {
     "@1password/eslint-config": "^4.0.0",