@maxim_mazurok/gapi.client.chromewebstore-v1.1 0.0.20251005

package/index.d.ts

@@ -0,0 +1,258 @@
+/* Type definitions for non-npm package Chrome Web Store API v1.1 0.0 */
+// Project: https://developer.chrome.com/webstore/api_index
+// Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
+//                 Nick Amoscato <https://github.com/namoscato>
+//                 Declan Vong <https://github.com/declanvong>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+// IMPORTANT
+// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
+// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
+// Generated from: https://chromewebstore.googleapis.com/$discovery/rest?version=v1.1
+// Revision: 20251005
+
+/// <reference types="gapi.client" />
+
+declare namespace gapi.client {
+  /** Load Chrome Web Store API v1.1 */
+  function load(
+    urlOrObject: 'https://chromewebstore.googleapis.com/$discovery/rest?version=v1.1',
+  ): Promise<void>;
+  /** @deprecated Please load APIs with discovery documents. */
+  function load(name: 'chromewebstore', version: 'v1.1'): Promise<void>;
+  /** @deprecated Please load APIs with discovery documents. */
+  function load(
+    name: 'chromewebstore',
+    version: 'v1.1',
+    callback: () => any,
+  ): void;
+
+  namespace chromewebstore {
+    interface Item {
+      /** The CRX version of the item. If the projection is draft, then it is the draft's CRX version. */
+      crxVersion?: string;
+      /** Unique ID of the item. */
+      id?: string;
+      /** Detail human-readable status of the operation, in English only. Same error messages are displayed when you upload your app to the Chrome Web Store. */
+      itemError?: ItemError[];
+      /** Identifies this resource as an Item. Value: the fixed string "chromewebstore#item". */
+      kind?: string;
+      /** Public key of this item. */
+      publicKey?: string;
+      /** Status of the operation. Possible values are: - \"FAILURE\" - \"IN_PROGRESS\" - \"NOT_FOUND\" - \"SUCCESS\" */
+      uploadState?: string;
+    }
+    interface Item2 {
+      /** The ID of this item. */
+      item_id?: string;
+      /** Static string value is always "chromewebstore#item". */
+      kind?: string;
+      /** The status code of this publish operation. It may contain multiple elements from the following list: NOT_AUTHORIZED, INVALID_DEVELOPER, DEVELOPER_NO_OWNERSHIP, DEVELOPER_SUSPENDED, ITEM_NOT_FOUND, ITEM_PENDING_REVIEW, ITEM_TAKEN_DOWN, PUBLISHER_SUSPENDED. */
+      status?: string[];
+      /** Detailed human-comprehensible explanation of the status code above. */
+      statusDetail?: string[];
+    }
+    interface ItemError {
+      /** The error code. */
+      error_code?: string;
+      /** The human-readable detail message of the error. */
+      error_detail?: string;
+    }
+    interface PublishRequest {
+      /** The target deploy percentage of the item. It's only useful for items with big user base. */
+      deployPercentage?: number;
+      /** Optional. The caller request to exempt the review and directly publish because the update is within the list that we can automatically validate. The API will check if the exemption can be granted using real time data. */
+      reviewExemption?: boolean;
+      /** The publish target of this publish operation. This is the same as using publishTarget as a URL query parameter. The string value can either be target="trustedTesters" or target="default". The default value, if none is supplied, is target="default". Recommended usage is to use the URL query parameter to specificy the value. */
+      target?: string;
+    }
+    interface ItemsResource {
+      /** Gets your own Chrome Web Store item. */
+      get(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** Unique identifier representing the Chrome App, Chrome Extension, or the Chrome Theme. */
+        itemId: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Determines which subset of the item information to return. */
+        projection?: string;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<Item>;
+      /** Inserts a new item. */
+      insert(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** The email of the publisher who owns the items. Defaults to the caller's email address. */
+        publisherEmail?: string;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<Item>;
+      /** Publishes an item. */
+      publish(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** The deploy percentage you want to set for your item. Valid values are [0, 100]. If set to any number less than 100, only that many percentage of users will be allowed to get the update. */
+        deployPercentage?: number;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** The ID of the item to publish. */
+        itemId: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Provide defined publishTarget in URL (case sensitive): publishTarget="trustedTesters" or publishTarget="default". Defaults to publishTarget="default". */
+        publishTarget?: string;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Optional. The caller request to exempt the review and directly publish because the update is within the list that we can automatically validate. The API will check if the exemption can be granted using real time data. */
+        reviewExemption?: boolean;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: PublishRequest;
+      }): Request<Item2>;
+      publish(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** The deploy percentage you want to set for your item. Valid values are [0, 100]. If set to any number less than 100, only that many percentage of users will be allowed to get the update. */
+          deployPercentage?: number;
+          /** Selector specifying which fields to include in a partial response. */
+          fields?: string;
+          /** The ID of the item to publish. */
+          itemId: string;
+          /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+          key?: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** Provide defined publishTarget in URL (case sensitive): publishTarget="trustedTesters" or publishTarget="default". Defaults to publishTarget="default". */
+          publishTarget?: string;
+          /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+          quotaUser?: string;
+          /** Optional. The caller request to exempt the review and directly publish because the update is within the list that we can automatically validate. The API will check if the exemption can be granted using real time data. */
+          reviewExemption?: boolean;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: PublishRequest,
+      ): Request<Item2>;
+      /** Updates an existing item. */
+      update(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** The ID of the item to upload. */
+        itemId: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: Item;
+      }): Request<Item>;
+      update(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Selector specifying which fields to include in a partial response. */
+          fields?: string;
+          /** The ID of the item to upload. */
+          itemId: string;
+          /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+          key?: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+          quotaUser?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: Item,
+      ): Request<Item>;
+    }
+
+    const items: ItemsResource;
+  }
+}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.chromewebstore-v1.1",
+  "version": "0.0.20251005",
+  "description": "TypeScript typings for Chrome Web Store API v1.1",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Maxim Mazurok",
+    "email": "maxim@mazurok.com",
+    "url": "https://maxim.mazurok.com"
+  },
+  "types": "index.d.ts",
+  "dependencies": {
+    "@types/gapi.client": "*",
+    "@types/gapi.client.discovery-v1": "*"
+  }
+}

package/readme.md

@@ -0,0 +1,96 @@
+# TypeScript typings for Chrome Web Store API v1.1
+
+The Chrome Web Store API provides access to data about apps and extensions, as well as developer tools for managing them.
+For detailed description please check [documentation](https://developer.chrome.com/webstore/api_index).
+
+## Installing
+
+Install typings for Chrome Web Store API:
+
+```
+npm install @types/gapi.client.chromewebstore-v1.1 --save-dev
+```
+
+## Usage
+
+You need to initialize Google API client in your code:
+
+```typescript
+gapi.load('client', () => {
+  // now we can use gapi.client
+  // ...
+});
+```
+
+Then load api client wrapper:
+
+```typescript
+gapi.client.load(
+  'https://chromewebstore.googleapis.com/$discovery/rest?version=v1.1',
+  () => {
+    // now we can use:
+    // gapi.client.chromewebstore
+  },
+);
+```
+
+```typescript
+// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
+gapi.client.load('chromewebstore', 'v1.1', () => {
+  // now we can use:
+  // gapi.client.chromewebstore
+});
+```
+
+Don't forget to authenticate your client before sending any request to resources:
+
+```typescript
+// declare client_id registered in Google Developers Console
+var client_id = '',
+  scope = [
+    // See, edit, update, or publish your Chrome Web Store extensions, themes, apps, and licences you have access to
+    'https://www.googleapis.com/auth/chromewebstore',
+
+    // See and download your Chrome Web Store extensions and apps, and see licenses you have access to
+    'https://www.googleapis.com/auth/chromewebstore.readonly',
+  ],
+  immediate = true;
+// ...
+
+gapi.auth.authorize(
+  {client_id: client_id, scope: scope, immediate: immediate},
+  authResult => {
+    if (authResult && !authResult.error) {
+      /* handle successful authorization */
+    } else {
+      /* handle authorization error */
+    }
+  },
+);
+```
+
+After that you can use Chrome Web Store API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+/*
+Gets your own Chrome Web Store item.
+*/
+await gapi.client.chromewebstore.items.get({itemId: 'itemId'});
+
+/*
+Inserts a new item.
+*/
+await gapi.client.chromewebstore.items.insert({});
+
+/*
+Publishes an item.
+*/
+await gapi.client.chromewebstore.items.publish({itemId: 'itemId'});
+
+/*
+Updates an existing item.
+*/
+await gapi.client.chromewebstore.items.update({itemId: 'itemId'});
+```
+
+For provenance information see [Provenance section on NPM](https://www.npmjs.com/package/@maxim_mazurok/gapi.client.chromewebstore-v1.1#Provenance:~:text=none-,Provenance,-Built%20and%20signed)