clarifai-web-grpc 10.1.6 → 10.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. package/README.md +13 -11
  2. package/VERSION +1 -1
  3. package/dist/cjs/index.d.ts +2 -1
  4. package/dist/cjs/index.js +8 -2
  5. package/dist/cjs/proto/clarifai/api/resources_pb.js +2827 -92
  6. package/dist/cjs/proto/clarifai/api/service_grpc_web_pb.js +90 -6
  7. package/dist/cjs/proto/clarifai/api/service_pb.js +10404 -8056
  8. package/dist/cjs/proto/clarifai/api/status/status_code_pb.js +10 -0
  9. package/dist/cjs/proto/clarifai/auth/scope/scope_pb.js +2 -0
  10. package/dist/cjs/resources.d.ts +1 -0
  11. package/dist/cjs/resources.js +3 -0
  12. package/dist/esm/index.d.ts +2 -1
  13. package/dist/esm/index.js +6 -2
  14. package/dist/esm/proto/clarifai/api/resources_pb.js +2827 -92
  15. package/dist/esm/proto/clarifai/api/service_grpc_web_pb.js +90 -6
  16. package/dist/esm/proto/clarifai/api/service_pb.js +10404 -8056
  17. package/dist/esm/proto/clarifai/api/status/status_code_pb.js +10 -0
  18. package/dist/esm/proto/clarifai/auth/scope/scope_pb.js +2 -0
  19. package/dist/esm/resources.d.ts +1 -0
  20. package/dist/esm/resources.js +1 -0
  21. package/examples/post-app.ts +27 -0
  22. package/examples/post-input.ts +42 -0
  23. package/index.ts +7 -2
  24. package/package.json +1 -1
  25. package/proto/clarifai/api/resources_pb.d.ts +456 -15
  26. package/proto/clarifai/api/resources_pb.js +3689 -274
  27. package/proto/clarifai/api/service_grpc_web_pb.d.ts +27 -3
  28. package/proto/clarifai/api/service_grpc_web_pb.js +128 -6
  29. package/proto/clarifai/api/service_pb.d.ts +355 -0
  30. package/proto/clarifai/api/service_pb.js +15757 -12851
  31. package/proto/clarifai/api/status/status_code_pb.d.ts +10 -0
  32. package/proto/clarifai/api/status/status_code_pb.js +10 -0
  33. package/proto/clarifai/auth/scope/scope_pb.d.ts +2 -0
  34. package/proto/clarifai/auth/scope/scope_pb.js +2 -0
  35. package/resources.ts +1 -0
package/README.md CHANGED
@@ -17,32 +17,34 @@ import { ClarifaiStub } from "clarifai-web-grpc";
17
17
  import { App } from "clarifai-web-grpc/proto/clarifai/api/resources_pb";
18
18
  import { PostAppsRequest } from "clarifai-web-grpc/proto/clarifai/api/service_pb";
19
19
 
20
- const client = ClarifaiStub.grpc();
21
- // use client to create an App
20
+ // get a client object
21
+ const client = ClarifaiStub.promise()
22
22
 
23
+ // create an app
23
24
  const app = new App();
24
25
  app.setId("cat-app");
25
26
  app.setDefaultWorkflowId("General-Detection");
26
27
  app.setDescription("An app for some cats");
27
28
 
29
+ // create a request
28
30
  const req = new PostAppsRequest();
29
31
  req.setAppsList([app]);
30
32
 
33
+ // send the request
31
34
  const auth = {
32
- "X-Clarifai-Session-Token": "MY-CLARIFAI-PERSONAL-ACCESS-TOKEN",
35
+ "authorization": `Key ${process.env.CLARIFAI_TOKEN}`,
33
36
  };
37
+ const resp = await client.postApps(req, auth);
34
38
 
35
- client.postApps(req, auth, (err, resp) => {
36
- if (err) {
37
- console.error(err);
38
- } else {
39
- console.log(resp.getAppsList()[0].getId()); // logs "cat-app"
40
- }
41
- });
39
+ // log the app id
40
+ console.log(resp.getAppsList()[0].getId());
42
41
  ```
43
42
 
44
- ## Publishing to NPM
43
+ ## Examples
44
+
45
+ See the examples directory for more examples of how to use the clarifai API client
45
46
 
47
+ ## Publishing to NPM
46
48
  Publishing the client to NPM involves merging a PR with 2 things:
47
49
  1. Updates the `version` field in `package.json` to the appropriate version.
48
50
  2. Commit message should begin with `"GRPC clients version"` eg `"GRPC clients version 9.4.0"`.
package/VERSION CHANGED
@@ -1 +1 @@
1
- 10.1.6
1
+ 10.3.0
@@ -1,7 +1,8 @@
1
1
  import { V2Client, V2PromiseClient } from './proto/clarifai/api/service_grpc_web_pb';
2
2
  export declare class ClarifaiStub {
3
3
  static grpc(hostname?: string): V2Client;
4
+ static promise(hostname?: string): V2PromiseClient;
4
5
  }
5
6
  export { V2Client, V2PromiseClient };
6
- export { RpcError, Metadata, ClientReadableStream } from 'grpc-web';
7
+ export { RpcError, Metadata, ClientReadableStream, Request, UnaryResponse } from 'grpc-web';
7
8
  export { BaseResponse } from './proto/clarifai/api/status/status_pb';
package/dist/cjs/index.js CHANGED
@@ -1,18 +1,24 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.BaseResponse = exports.ClientReadableStream = exports.RpcError = exports.V2PromiseClient = exports.V2Client = exports.ClarifaiStub = void 0;
3
+ exports.BaseResponse = exports.UnaryResponse = exports.Request = exports.ClientReadableStream = exports.RpcError = exports.V2PromiseClient = exports.V2Client = exports.ClarifaiStub = void 0;
4
4
  const service_grpc_web_pb_1 = require("./proto/clarifai/api/service_grpc_web_pb");
5
5
  Object.defineProperty(exports, "V2Client", { enumerable: true, get: function () { return service_grpc_web_pb_1.V2Client; } });
6
6
  Object.defineProperty(exports, "V2PromiseClient", { enumerable: true, get: function () { return service_grpc_web_pb_1.V2PromiseClient; } });
7
7
  class ClarifaiStub {
8
- static grpc(hostname = 'api.clarifai.com') {
8
+ static grpc(hostname = 'https://api-grpc-web.clarifai.com') {
9
9
  const options = { 'grpc.max_receive_message_length': 128 * 1024 * 1024 }; // 128 MB
10
10
  return new service_grpc_web_pb_1.V2Client(hostname, null, options);
11
11
  }
12
+ static promise(hostname = 'https://api-grpc-web.clarifai.com') {
13
+ const options = { 'grpc.max_receive_message_length': 128 * 1024 * 1024 }; // 128 MB
14
+ return new service_grpc_web_pb_1.V2PromiseClient(hostname, null, options);
15
+ }
12
16
  }
13
17
  exports.ClarifaiStub = ClarifaiStub;
14
18
  var grpc_web_1 = require("grpc-web");
15
19
  Object.defineProperty(exports, "RpcError", { enumerable: true, get: function () { return grpc_web_1.RpcError; } });
16
20
  Object.defineProperty(exports, "ClientReadableStream", { enumerable: true, get: function () { return grpc_web_1.ClientReadableStream; } });
21
+ Object.defineProperty(exports, "Request", { enumerable: true, get: function () { return grpc_web_1.Request; } });
22
+ Object.defineProperty(exports, "UnaryResponse", { enumerable: true, get: function () { return grpc_web_1.UnaryResponse; } });
17
23
  var status_pb_1 = require("./proto/clarifai/api/status/status_pb");
18
24
  Object.defineProperty(exports, "BaseResponse", { enumerable: true, get: function () { return status_pb_1.BaseResponse; } });