JS SDK Release V0.3.0 (#143)

* Update core to version e1f91a18

* update example

* Release v0.3.0

* update release notes

* update release notes

* update wording of breaking changes

* Apply suggestions from code review

Co-authored-by: Lucy Butcher <89952129+libutcher@users.noreply.github.com>

* update release notes

* Remove some unnecessary text

* remove unnecessary log

* add error check for misisng op-vault-id env and remove unnecessary await keyword

* update release notes

* remove unnecessary await

* Update package.json's

---------

Co-authored-by: 1PasswordSDKBot <it-github-sdk-bot@agilebits.com>
Co-authored-by: Lucy Butcher <89952129+libutcher@users.noreply.github.com>

Author: 3 people

client/package.json

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

client/release/RELEASE-NOTES

@@ -1,20 +1,68 @@
-# 1Password JavaScript SDK v0.2.1
+# 1Password JavaScript SDK v0.3.0
 
 ## NEW
 
-- **`CreatedAt` and `UpdatedAt` item metadata:** Items and item overviews now expose attributes with their creation and last edit times.
-- **Resolving secrets in bulk**: With the `client.secrets.resolveAll` function, the SDK is now able to resolve multiple secrets at once, improving the performance of the operation.
+- **Support for item states**: You can now fetch an item's state using the SDK. `ItemOverview` exposes one of two states: `Active` or `Archived`.
+    - `Active`: An item located inside a vault. (Default)
+    - `Archived`: An item that has been moved to the Archive. 1Password doesn't include archived items in search results or suggest them when you fill in apps and browsers. You can keep archived items as long as you'd like.
+- **Filtering listed items by state**: You can now filter the results of the item list function by item state.
 
-## IMPROVED
+## FIXED
 
-- **Support for new field types:** Items with `Address` and `Date` fields can now be created, retrieved, and edited using the 1Password SDK.
-- **Item sharing for attachments and documents**: Items with files attached now can also be shared using the `client.items.shares` functions.
-- **Adding custom fields in sections automatically**: The SDK now automatically adds custom fields without a section to an empty section within the item, creating it if necessary.
-- **`Tags` in item overviews**: The return type of `items.listAll` now also contains the item tags.
-- **Broader item editing capabilities**: You are now able to use the `items.put` function on more items, including those with fields that are not directly editable through the SDK (such as legacy fields, passkeys etc.)
+- **Deleting Archived Items:** The SDK now supports deleting items from the archive.
 
-## FIXED
+### ⚠️ BREAKING CHANGES ⚠️
+This release contains breaking changes for two functions in the JS SDK.
+
+**Vault listing**
+
+* The function name has changed from `listAll` to `list`. To use this in your code, replace:
+```js
+const vaults = await client.vaults.listAll();
+```
+with:
+```js
+const vaults = await client.vaults.list();
+```
+
+* The return type of the vault listing functions has changed from `SdkIterable<VaultOverview>` to `VaultOverview[]`. To use this in your code, replace:
+```js
+for await (const vault of vaults) {
+  console.log(vault.id + " " + vault.title);
+}
+```
+with:
+```js
+for (const vault of vaults) {
+  console.log(vault.id + " " + vault.title);
+}
+```
+
+**Item listing**
+
+* The function name has changed from `listAll` to `list`. To use this in your code, replace:
+```js
+const overviews = await client.items.listAll(vault.id);
+```
+with:
+```js
+const overviews = await client.items.list(vault.id, {
+        type: "ByState",
+        content: { active: true, archived: true },
+      })
+```
+
+* The return type of the item listing functions has changed from `SdkIterable<ItemOverview>` to `ItemOverview[]`. To use this in your code, replace:
+```js
+for await (const overview of overviews) {
+  console.log(overview.id + " " + overview.title);
+}
+```
+with:
+```js
+for (const overview of overviews) {
+  console.log(overview.id + " " + overview.title);
+}
+```
 
-- **Improvements to resolving secret references:**
-    - Archived items are no longer used for secret references.
-    - When multiple sections match a section query in resolving secret references, the SDK look through the fields in all sections, instead of erroring.
+This does not affect any code that's already deployed, and will not take effect in your codebase until you choose to update to version 0.3.0 or later of the 1Password JS SDK.

client/src/items.ts

@@ -1,8 +1,13 @@
 // Code generated by op-codegen - DO NOT EDIT MANUALLY
 
 import { InvokeConfig, InnerClient, SharedCore } from "./core.js";
-import { SdkIterable } from "./iterator.js";
-import { Item, ItemCreateParams, ItemOverview, ReviverFunc } from "./types.js";
+import {
+  Item,
+  ItemCreateParams,
+  ItemListFilter,
+  ItemOverview,
+  ReviverFunc,
+} from "./types.js";
 import { ItemsSharesApi, ItemsShares } from "./items_shares.js";
 import { ItemsFilesApi, ItemsFiles } from "./items_files.js";
 
@@ -38,9 +43,9 @@ export interface ItemsApi {
   archive(vaultId: string, itemId: string);
 
   /**
-   * List all items
+   * List items based on filters.
    */
-  listAll(vaultId: string): Promise<SdkIterable<ItemOverview>>;
+  list(vaultId: string, ...filters: ItemListFilter[]): Promise<ItemOverview[]>;
 }
 
 export class Items implements ItemsApi {
@@ -72,7 +77,7 @@ export class Items implements ItemsApi {
     return JSON.parse(
       await this.#inner.core.invoke(invocationConfig),
       ReviverFunc,
-    ) as Promise<Item>;
+    ) as Item;
   }
 
   /**
@@ -94,7 +99,7 @@ export class Items implements ItemsApi {
     return JSON.parse(
       await this.#inner.core.invoke(invocationConfig),
       ReviverFunc,
-    ) as Promise<Item>;
+    ) as Item;
   }
 
   /**
@@ -115,7 +120,7 @@ export class Items implements ItemsApi {
     return JSON.parse(
       await this.#inner.core.invoke(invocationConfig),
       ReviverFunc,
-    ) as Promise<Item>;
+    ) as Item;
   }
 
   /**
@@ -157,25 +162,27 @@ export class Items implements ItemsApi {
   }
 
   /**
-   * List all items
+   * List items based on filters.
    */
-  public async listAll(vaultId: string): Promise<SdkIterable<ItemOverview>> {
+  public async list(
+    vaultId: string,
+    ...filters: ItemListFilter[]
+  ): Promise<ItemOverview[]> {
     const invocationConfig: InvokeConfig = {
       invocation: {
         clientId: this.#inner.id,
         parameters: {
-          name: "ItemsListAll",
+          name: "ItemsList",
           parameters: {
             vault_id: vaultId,
+            filters,
           },
         },
       },
     };
-    return new SdkIterable<ItemOverview>(
-      JSON.parse(
-        await this.#inner.core.invoke(invocationConfig),
-        ReviverFunc,
-      ) as ItemOverview[],
-    );
+    return JSON.parse(
+      await this.#inner.core.invoke(invocationConfig),
+      ReviverFunc,
+    ) as ItemOverview[];
   }
 }

client/src/items_files.ts

@@ -1,7 +1,6 @@
 // Code generated by op-codegen - DO NOT EDIT MANUALLY
 
 import { InvokeConfig, InnerClient, SharedCore } from "./core.js";
-import { SdkIterable } from "./iterator.js";
 import {
   DocumentCreateParams,
   FileAttributes,
@@ -62,7 +61,7 @@ export class ItemsFiles implements ItemsFilesApi {
     return JSON.parse(
       await this.#inner.core.invoke(invocationConfig),
       ReviverFunc,
-    ) as Promise<Item>;
+    ) as Item;
   }
 
   /**
@@ -89,7 +88,7 @@ export class ItemsFiles implements ItemsFilesApi {
     return JSON.parse(
       await this.#inner.core.invoke(invocationConfig),
       ReviverFunc,
-    ) as Promise<Uint8Array>;
+    ) as Uint8Array;
   }
 
   /**
@@ -116,7 +115,7 @@ export class ItemsFiles implements ItemsFilesApi {
     return JSON.parse(
       await this.#inner.core.invoke(invocationConfig),
       ReviverFunc,
-    ) as Promise<Item>;
+    ) as Item;
   }
 
   /**
@@ -141,6 +140,6 @@ export class ItemsFiles implements ItemsFilesApi {
     return JSON.parse(
       await this.#inner.core.invoke(invocationConfig),
       ReviverFunc,
-    ) as Promise<Item>;
+    ) as Item;
   }
 }

client/src/items_shares.ts

@@ -1,7 +1,6 @@
 // Code generated by op-codegen - DO NOT EDIT MANUALLY
 
 import { InvokeConfig, InnerClient, SharedCore } from "./core.js";
-import { SdkIterable } from "./iterator.js";
 import {
   Item,
   ItemShareAccountPolicy,
@@ -66,7 +65,7 @@ export class ItemsShares implements ItemsSharesApi {
     return JSON.parse(
       await this.#inner.core.invoke(invocationConfig),
       ReviverFunc,
-    ) as Promise<ItemShareAccountPolicy>;
+    ) as ItemShareAccountPolicy;
   }
 
   /**
@@ -91,7 +90,7 @@ export class ItemsShares implements ItemsSharesApi {
     return JSON.parse(
       await this.#inner.core.invoke(invocationConfig),
       ReviverFunc,
-    ) as Promise<ValidRecipient[]>;
+    ) as ValidRecipient[];
   }
 
   /**
@@ -118,6 +117,6 @@ export class ItemsShares implements ItemsSharesApi {
     return JSON.parse(
       await this.#inner.core.invoke(invocationConfig),
       ReviverFunc,
-    ) as Promise<string>;
+    ) as string;
   }
 }

client/src/iterator.ts

@@ -1,7 +1,6 @@
 // Code generated by op-codegen - DO NOT EDIT MANUALLY
 
 import { InvokeConfig, InnerClient, SharedCore } from "./core.js";
-import { SdkIterable } from "./iterator.js";
 import {
   GeneratePasswordResponse,
   PasswordRecipe,
@@ -50,7 +49,7 @@ export class Secrets implements SecretsApi {
     return JSON.parse(
       await this.#inner.core.invoke(invocationConfig),
       ReviverFunc,
-    ) as Promise<string>;
+    ) as string;
   }
 
   /**
@@ -73,7 +72,7 @@ export class Secrets implements SecretsApi {
     return JSON.parse(
       await this.#inner.core.invoke(invocationConfig),
       ReviverFunc,
-    ) as Promise<ResolveAllResponse>;
+    ) as ResolveAllResponse;
   }
 
   /**

client/src/secrets.ts

@@ -169,7 +169,7 @@ export interface ItemFile {
   fieldId: string;
 }
 
-/** Represents a 1Password item. */
+/** Represents an active 1Password item. */
 export interface Item {
   /** The item's ID */
   id: string;
@@ -224,6 +224,14 @@ export interface ItemCreateParams {
   document?: DocumentCreateParams;
 }
 
+/** Represents the state of an item in the SDK. */
+export enum ItemState {
+  /** The item is active */
+  Active = "active",
+  /** The item is archived meaning it's hidden from regular view and stored in the archive. */
+  Archived = "archived",
+}
+
 /** Represents a decrypted 1Password item overview. */
 export interface ItemOverview {
   /** The item's ID */
@@ -242,6 +250,8 @@ export interface ItemOverview {
   createdAt: Date;
   /** The time the item was updated at */
   updatedAt: Date;
+  /** Indicates the state of the item */
+  state: ItemState;
 }
 
 /** The valid duration options for sharing an item */
@@ -418,6 +428,14 @@ export interface VaultOverview {
   title: string;
 }
 
+export type ItemListFilter = {
+  type: "ByState";
+  content: {
+    active: boolean;
+    archived: boolean;
+  };
+};
+
 export type PasswordRecipe =
   | {
       type: "Memorable";