@1password/sdk 0.1.3 → 0.1.5

package/README.md

@@ -86,6 +86,7 @@ Operations:
 - [x] [Delete items](https://developer.1password.com/docs/sdks/manage-items#delete-an-item)
 - [x] [List items](https://developer.1password.com/docs/sdks/list-vaults-items/)
 - [x] Add & update tags on items
+- [x] Generate PIN, random and memorable passwords
 
 Field types:
 - [x] API Keys
@@ -100,6 +101,7 @@ Field types:
 - [x] Websites (used to suggest and autofill logins)
 - [x] Phone numbers
 - [x] Credit card types
+- [x] Credit card numbers
 - [ ] File attachments and Document items
 
 ### Vault management

package/dist/configuration.d.ts

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

package/dist/core.d.ts

@@ -7,9 +7,13 @@ export interface Core {
      */
     initClient(config: ClientAuthConfig): Promise<string>;
     /**
-     *  Calls business logic from a given client and returns the result.
+     *  Calls async business logic from a given client and returns the result.
      */
     invoke(config: InvokeConfig): Promise<string>;
+    /**
+     *  Calls sync business logic from a given client and returns the result.
+     */
+    invoke_sync(config: InvokeConfig): string;
     /**
      *  Deallocates memory held by the given client in the SDK core when it goes out of scope.
      */
@@ -65,6 +69,7 @@ export interface Parameters {
  *  An implementation of the `Core` interface that shares resources across all clients.
  */
 export declare class SharedCore implements Core {
+    invoke_sync(config: InvokeConfig): string;
     initClient(config: ClientAuthConfig): Promise<string>;
     invoke(config: InvokeConfig): Promise<string>;
     releaseClient(clientId: number): void;

package/dist/core.js

@@ -15,6 +15,10 @@ const sdk_core_1 = require("@1password/sdk-core");
  *  An implementation of the `Core` interface that shares resources across all clients.
  */
 class SharedCore {
+    invoke_sync(config) {
+        const serializedConfig = JSON.stringify(config);
+        return (0, sdk_core_1.invoke_sync)(serializedConfig);
+    }
     initClient(config) {
         return __awaiter(this, void 0, void 0, function* () {
             const serializedConfig = JSON.stringify(config);

package/dist/items.d.ts

@@ -20,7 +20,7 @@ export interface ItemsApi {
     /**
      * Delete an item.
      */
-    delete(vaultId: string, itemId: string): Promise<void>;
+    delete(vaultId: string, itemId: string): any;
     /**
      * List all items
      */

package/dist/iterator.js

@@ -3,7 +3,7 @@ var __await = (this && this.__await) || function (v) { return this instanceof __
 var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
     if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
     var g = generator.apply(thisArg, _arguments || []), i, q = [];
-    return i = {}, verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
+    return i = Object.create((typeof AsyncIterator === "function" ? AsyncIterator : Object).prototype), verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
     function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }
     function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }
     function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }

package/dist/sdk.js

@@ -28,6 +28,7 @@ const core_js_1 = require("./core.js");
 const client_builder_js_1 = require("./client_builder.js");
 exports.DEFAULT_INTEGRATION_NAME = "Unknown";
 exports.DEFAULT_INTEGRATION_VERSION = "Unknown";
+// auto-generated static exports
 var secrets_js_1 = require("./secrets.js");
 Object.defineProperty(exports, "Secrets", { enumerable: true, get: function () { return secrets_js_1.Secrets; } });
 __exportStar(require("./client.js"), exports);

package/dist/secrets.d.ts

@@ -1,4 +1,5 @@
 import { InnerClient } from "./core.js";
+import * as types 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>
@@ -16,4 +17,9 @@ export declare class Secrets implements SecretsApi {
      * Resolve returns the secret the provided secret reference points to.
      */
     resolve(secretReference: string): Promise<string>;
+    /**
+     * Validate the secret reference to ensure there are no syntax errors.
+     */
+    static validateSecretReference(secretReference: string): void;
+    static generatePassword(recipe: types.PasswordRecipe): types.GeneratePasswordResponse;
 }

package/dist/secrets.js

@@ -23,6 +23,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _Secrets_inner;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Secrets = void 0;
+const core_js_1 = require("./core.js");
 class Secrets {
     constructor(inner) {
         _Secrets_inner.set(this, void 0);
@@ -47,6 +48,37 @@ class Secrets {
             return JSON.parse(yield __classPrivateFieldGet(this, _Secrets_inner, "f").core.invoke(invocationConfig));
         });
     }
+    /**
+     * Validate the secret reference to ensure there are no syntax errors.
+     */
+    static validateSecretReference(secretReference) {
+        const sharedCore = new core_js_1.SharedCore();
+        const invocationConfig = {
+            invocation: {
+                parameters: {
+                    name: "ValidateSecretReference",
+                    parameters: {
+                        secret_reference: secretReference,
+                    },
+                },
+            },
+        };
+        sharedCore.invoke_sync(invocationConfig);
+    }
+    static generatePassword(recipe) {
+        const sharedCore = new core_js_1.SharedCore();
+        const invocationConfig = {
+            invocation: {
+                parameters: {
+                    name: "GeneratePassword",
+                    parameters: {
+                        recipe,
+                    },
+                },
+            },
+        };
+        return JSON.parse(sharedCore.invoke_sync(invocationConfig));
+    }
 }
 exports.Secrets = Secrets;
 _Secrets_inner = new WeakMap();

package/dist/types.d.ts

@@ -1,3 +1,11 @@
+/**
+ * For future use, if we want to return more information about the generated password.
+ * Currently, it only returns the password itself.
+ */
+export interface GeneratePasswordResponse {
+    /** The generated password. */
+    password: string;
+}
 export declare enum ItemCategory {
     Login = "Login",
     SecureNote = "SecureNote",
@@ -28,6 +36,7 @@ export declare enum ItemFieldType {
     Text = "Text",
     Concealed = "Concealed",
     CreditCardType = "CreditCardType",
+    CreditCardNumber = "CreditCardNumber",
     Phone = "Phone",
     Url = "Url",
     Totp = "Totp",
@@ -152,3 +161,79 @@ export interface VaultOverview {
     /** The vault's title */
     title: string;
 }
+export type PasswordRecipe = {
+    type: "Memorable";
+    parameters: {
+        /** The type of separator between chunks. */
+        separatorType: SeparatorType;
+        /** Uppercase one randomly selected chunk. */
+        capitalize: boolean;
+        /** The type of word list used. */
+        wordListType: WordListType;
+        /** The number of "words" (words or syllables). */
+        wordCount: number;
+    };
+} | {
+    type: "Pin";
+    parameters: {
+        /** Number of digits in the PIN. */
+        length: number;
+    };
+} | {
+    type: "Random";
+    parameters: {
+        /** Include at least one digit in the password. */
+        includeDigits: boolean;
+        /** Include at least one symbol in the password. */
+        includeSymbols: boolean;
+        /** The length of the password. */
+        length: number;
+    };
+};
+export declare enum SeparatorType {
+    /**
+     * Randomly selected digits.
+     * E.g, "`correct4horse0battery1staple`"
+     */
+    Digits = "digits",
+    /**
+     * Randomly selected digits and symbols.
+     * This is useful to get word-based passwords to meet complexity requirements
+     * E.g, "`correct4horse-battery1staple`"
+     */
+    DigitsAndSymbols = "digitsAndSymbols",
+    /**
+     * Spaces, like the original Diceware.
+     * Great for mobile keyboards, not so great when people can overhear you type the password.
+     * E.g, "`correct horse battery staple`"
+     */
+    Spaces = "spaces",
+    /**
+     * Hyphens "`-`".
+     * E.g, "`correct-horse-battery-staple`"
+     */
+    Hyphens = "hyphens",
+    /**
+     * "`_`".
+     * E.g, "`correct_horse_battery_staple`"
+     */
+    Underscores = "underscores",
+    /**
+     * Period (full stop) "`.`".
+     * E.g, "`correct.horse.battery.staple`"
+     */
+    Periods = "periods",
+    /**
+     * Comma "`,`".
+     * E.g, "`correct,horse,battery,staple`"
+     */
+    Commas = "commas"
+}
+export declare enum WordListType {
+    /** Agile wordlist */
+    FullWords = "fullWords",
+    /** English-like syllables */
+    Syllables = "syllables",
+    /** Three (random) letter "words" */
+    ThreeLetters = "threeLetters"
+}

package/dist/types.js

@@ -1,9 +1,9 @@
 "use strict";
 /*
- Generated by typeshare 1.11.0
+ Generated by typeshare 1.12.0
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AutofillBehavior = exports.ItemFieldType = exports.ItemCategory = void 0;
+exports.WordListType = exports.SeparatorType = exports.AutofillBehavior = exports.ItemFieldType = exports.ItemCategory = void 0;
 var ItemCategory;
 (function (ItemCategory) {
     ItemCategory["Login"] = "Login";
@@ -36,6 +36,7 @@ var ItemFieldType;
     ItemFieldType["Text"] = "Text";
     ItemFieldType["Concealed"] = "Concealed";
     ItemFieldType["CreditCardType"] = "CreditCardType";
+    ItemFieldType["CreditCardNumber"] = "CreditCardNumber";
     ItemFieldType["Phone"] = "Phone";
     ItemFieldType["Url"] = "Url";
     ItemFieldType["Totp"] = "Totp";
@@ -56,3 +57,52 @@ var AutofillBehavior;
     /** Never auto-fill on this website */
     AutofillBehavior["Never"] = "Never";
 })(AutofillBehavior || (exports.AutofillBehavior = AutofillBehavior = {}));
+var SeparatorType;
+(function (SeparatorType) {
+    /**
+     * Randomly selected digits.
+     * E.g, "`correct4horse0battery1staple`"
+     */
+    SeparatorType["Digits"] = "digits";
+    /**
+     * Randomly selected digits and symbols.
+     * This is useful to get word-based passwords to meet complexity requirements
+     * E.g, "`correct4horse-battery1staple`"
+     */
+    SeparatorType["DigitsAndSymbols"] = "digitsAndSymbols";
+    /**
+     * Spaces, like the original Diceware.
+     * Great for mobile keyboards, not so great when people can overhear you type the password.
+     * E.g, "`correct horse battery staple`"
+     */
+    SeparatorType["Spaces"] = "spaces";
+    /**
+     * Hyphens "`-`".
+     * E.g, "`correct-horse-battery-staple`"
+     */
+    SeparatorType["Hyphens"] = "hyphens";
+    /**
+     * "`_`".
+     * E.g, "`correct_horse_battery_staple`"
+     */
+    SeparatorType["Underscores"] = "underscores";
+    /**
+     * Period (full stop) "`.`".
+     * E.g, "`correct.horse.battery.staple`"
+     */
+    SeparatorType["Periods"] = "periods";
+    /**
+     * Comma "`,`".
+     * E.g, "`correct,horse,battery,staple`"
+     */
+    SeparatorType["Commas"] = "commas";
+})(SeparatorType || (exports.SeparatorType = SeparatorType = {}));
+var WordListType;
+(function (WordListType) {
+    /** Agile wordlist */
+    WordListType["FullWords"] = "fullWords";
+    /** English-like syllables */
+    WordListType["Syllables"] = "syllables";
+    /** Three (random) letter "words" */
+    WordListType["ThreeLetters"] = "threeLetters";
+})(WordListType || (exports.WordListType = WordListType = {}));

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-export declare const SDK_VERSION = "0.1.3";
-export declare const SDK_BUILD_NUMBER = "0010301";
+export declare const SDK_VERSION = "0.1.5";
+export declare const SDK_BUILD_NUMBER = "0010501";

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.1.3";
-exports.SDK_BUILD_NUMBER = "0010301";
-const SDK_CORE_VERSION = "0.1.3";
+exports.SDK_VERSION = "0.1.5";
+exports.SDK_BUILD_NUMBER = "0010501";
+const SDK_CORE_VERSION = "0.1.5";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@1password/sdk",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "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.1.3"
+    "@1password/sdk-core": "0.1.5"
   },
   "devDependencies": {
     "@1password/eslint-config": "^4.0.0",