@maxim_mazurok/gapi.client.dataform-v1 0.0.20251018

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.dataform-v1",
+  "version": "0.0.20251018",
+  "description": "TypeScript typings for Dataform API v1",
+  "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,78 @@
+# TypeScript typings for Dataform API v1
+
+Service to develop, version control, and operationalize SQL pipelines in BigQuery.
+For detailed description please check [documentation](https://cloud.google.com/dataform/docs).
+
+## Installing
+
+Install typings for Dataform API:
+
+```
+npm install @types/gapi.client.dataform-v1 --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://dataform.googleapis.com/$discovery/rest?version=v1',
+  () => {
+    // now we can use:
+    // gapi.client.dataform
+  },
+);
+```
+
+```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('dataform', 'v1', () => {
+  // now we can use:
+  // gapi.client.dataform
+});
+```
+
+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 = [
+    // View and manage your data in Google BigQuery and see the email address for your Google Account
+    'https://www.googleapis.com/auth/bigquery',
+
+    // See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
+    'https://www.googleapis.com/auth/cloud-platform',
+  ],
+  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 Dataform API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+
+```
+
+For provenance information see [Provenance section on NPM](https://www.npmjs.com/package/@maxim_mazurok/gapi.client.dataform-v1#Provenance:~:text=none-,Provenance,-Built%20and%20signed)