@unngh/google-vision 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,95 @@
+/**
+ * TypeScript type definitions for the dart2js-compiled google_vision
+ * runtime and the public API surface.
+ */
+/**
+ * Raw handle returned by `GoogleVisionJs.create()`.
+ *
+ * Each method on this handle is a closure that captures the underlying
+ * Dart `GoogleVision` instance. Promise-returning methods use native
+ * JS `Promise`, automatically converted from Dart `Future` by dart2js.
+ */
+interface VisionJsHandle {
+    /** Synchronous — returns the handle for chaining. */
+    withApiKey(apiKey: string): VisionJsHandle;
+    /** Asynchronous — resolves with the handle after JWT auth. */
+    withJwt(credentialsJson: string, scope?: string): Promise<VisionJsHandle>;
+    /** Image source can be a URL string or an object with `imageUri` / `content` (base64). */
+    imageLabelDetection(imageSource: string | ImageSource, maxResults?: number): Promise<Record<string, any>[]>;
+    imageTextDetection(imageSource: string | ImageSource, maxResults?: number): Promise<Record<string, any>[]>;
+    imageFaceDetection(imageSource: string | ImageSource, maxResults?: number): Promise<Record<string, any>[]>;
+    imageSafeSearchDetection(imageSource: string | ImageSource, maxResults?: number): Promise<Record<string, any> | null>;
+    imageCropHints(imageSource: string | ImageSource, maxResults?: number): Promise<Record<string, any> | null>;
+    imageDocumentTextDetection(imageSource: string | ImageSource, maxResults?: number): Promise<Record<string, any> | null>;
+    imageProperties(imageSource: string | ImageSource, maxResults?: number): Promise<Record<string, any> | null>;
+    imageLandmarkDetection(imageSource: string | ImageSource, maxResults?: number): Promise<Record<string, any>[]>;
+    imageLogoDetection(imageSource: string | ImageSource, maxResults?: number): Promise<Record<string, any>[]>;
+    imageObjectLocalization(imageSource: string | ImageSource, maxResults?: number): Promise<Record<string, any>[]>;
+    imageWebDetection(imageSource: string | ImageSource, maxResults?: number): Promise<Record<string, any> | null>;
+    fileLabelDetection(gcsUri: string, maxResults?: number): Promise<Record<string, any>[]>;
+    fileTextDetection(gcsUri: string, maxResults?: number): Promise<Record<string, any>[]>;
+    fileDocumentTextDetection(gcsUri: string, maxResults?: number): Promise<Record<string, any>[]>;
+    fileFaceDetection(gcsUri: string, maxResults?: number): Promise<Record<string, any>[]>;
+}
+/**
+ * Image source: either a URL string or an object with `imageUri` or `content`.
+ */
+interface ImageSource {
+    imageUri?: string;
+    content?: string;
+}
+
+/**
+ * Loads the dart2js-compiled runtime and returns the `GoogleVisionJs`
+ * namespace installed on `globalThis`. Dispatch is platform-specific — see
+ * `browser.ts` and `node.ts` for the actual loader implementations.
+ */
+
+type DartRuntimeLoader = () => Promise<void>;
+
+/**
+ * google_vision_js — public TypeScript API.
+ *
+ * This facade wraps the dart2js-compiled `google_vision` core, exposing an
+ * idiomatic JavaScript API: Promise-based methods, `image` and `file`
+ * sub-APIs that mirror the Dart API shape.
+ */
+
+/** Sub-API for image-based Google Vision operations. */
+declare class GoogleVisionImage {
+    private readonly handle;
+    constructor(handle: VisionJsHandle);
+    labelDetection(imageSource: string | ImageSource, maxResults?: number): Promise<Record<string, any>[]>;
+    textDetection(imageSource: string | ImageSource, maxResults?: number): Promise<Record<string, any>[]>;
+    faceDetection(imageSource: string | ImageSource, maxResults?: number): Promise<Record<string, any>[]>;
+    safeSearchDetection(imageSource: string | ImageSource, maxResults?: number): Promise<Record<string, any> | null>;
+    cropHints(imageSource: string | ImageSource, maxResults?: number): Promise<Record<string, any> | null>;
+    documentTextDetection(imageSource: string | ImageSource, maxResults?: number): Promise<Record<string, any> | null>;
+    imageProperties(imageSource: string | ImageSource, maxResults?: number): Promise<Record<string, any> | null>;
+    landmarkDetection(imageSource: string | ImageSource, maxResults?: number): Promise<Record<string, any>[]>;
+    logoDetection(imageSource: string | ImageSource, maxResults?: number): Promise<Record<string, any>[]>;
+    objectLocalization(imageSource: string | ImageSource, maxResults?: number): Promise<Record<string, any>[]>;
+    webDetection(imageSource: string | ImageSource, maxResults?: number): Promise<Record<string, any> | null>;
+}
+/** Sub-API for file-based Google Vision operations (PDFs, GCS files). */
+declare class GoogleVisionFile {
+    private readonly handle;
+    constructor(handle: VisionJsHandle);
+    labelDetection(gcsUri: string, maxResults?: number): Promise<Record<string, any>[]>;
+    textDetection(gcsUri: string, maxResults?: number): Promise<Record<string, any>[]>;
+    documentTextDetection(gcsUri: string, maxResults?: number): Promise<Record<string, any>[]>;
+    faceDetection(gcsUri: string, maxResults?: number): Promise<Record<string, any>[]>;
+}
+declare class GoogleVision {
+    private readonly handle;
+    readonly image: GoogleVisionImage;
+    readonly file: GoogleVisionFile;
+    protected constructor(handle: VisionJsHandle);
+    static create(loader?: DartRuntimeLoader): Promise<GoogleVision>;
+    /** Authenticate using an API key (synchronous, chainable). */
+    withApiKey(apiKey: string): this;
+    /** Authenticate using JWT credentials (asynchronous, chainable). */
+    withJwt(credentialsJson: string, scope?: string): Promise<this>;
+}
+
+export { GoogleVision, type ImageSource };

package/dist/index.js

@@ -0,0 +1,107 @@
+// src/runtime.ts
+var cached;
+async function getRuntime(loader) {
+  if (cached) return cached;
+  await loader();
+  const ns = globalThis.GoogleVisionJs;
+  if (!ns) {
+    throw new Error(
+      "google_vision_js runtime failed to initialise: globalThis.GoogleVisionJs was not installed."
+    );
+  }
+  cached = ns;
+  return ns;
+}
+
+// src/index.ts
+var GoogleVisionImage = class {
+  constructor(handle) {
+    this.handle = handle;
+  }
+  handle;
+  labelDetection(imageSource, maxResults) {
+    return this.handle.imageLabelDetection(imageSource, maxResults);
+  }
+  textDetection(imageSource, maxResults) {
+    return this.handle.imageTextDetection(imageSource, maxResults);
+  }
+  faceDetection(imageSource, maxResults) {
+    return this.handle.imageFaceDetection(imageSource, maxResults);
+  }
+  safeSearchDetection(imageSource, maxResults) {
+    return this.handle.imageSafeSearchDetection(imageSource, maxResults);
+  }
+  cropHints(imageSource, maxResults) {
+    return this.handle.imageCropHints(imageSource, maxResults);
+  }
+  documentTextDetection(imageSource, maxResults) {
+    return this.handle.imageDocumentTextDetection(imageSource, maxResults);
+  }
+  imageProperties(imageSource, maxResults) {
+    return this.handle.imageProperties(imageSource, maxResults);
+  }
+  landmarkDetection(imageSource, maxResults) {
+    return this.handle.imageLandmarkDetection(imageSource, maxResults);
+  }
+  logoDetection(imageSource, maxResults) {
+    return this.handle.imageLogoDetection(imageSource, maxResults);
+  }
+  objectLocalization(imageSource, maxResults) {
+    return this.handle.imageObjectLocalization(imageSource, maxResults);
+  }
+  webDetection(imageSource, maxResults) {
+    return this.handle.imageWebDetection(imageSource, maxResults);
+  }
+};
+var GoogleVisionFile = class {
+  constructor(handle) {
+    this.handle = handle;
+  }
+  handle;
+  labelDetection(gcsUri, maxResults) {
+    return this.handle.fileLabelDetection(gcsUri, maxResults);
+  }
+  textDetection(gcsUri, maxResults) {
+    return this.handle.fileTextDetection(gcsUri, maxResults);
+  }
+  documentTextDetection(gcsUri, maxResults) {
+    return this.handle.fileDocumentTextDetection(gcsUri, maxResults);
+  }
+  faceDetection(gcsUri, maxResults) {
+    return this.handle.fileFaceDetection(gcsUri, maxResults);
+  }
+};
+var GoogleVision = class _GoogleVision {
+  constructor(handle) {
+    this.handle = handle;
+    this.image = new GoogleVisionImage(handle);
+    this.file = new GoogleVisionFile(handle);
+  }
+  handle;
+  image;
+  file;
+  static async create(loader) {
+    if (!loader) {
+      throw new Error(
+        "No Dart runtime loader provided. Import from '@unngh/google-vision/node' or '@unngh/google-vision/browser' instead."
+      );
+    }
+    const ns = await getRuntime(loader);
+    const handle = ns.create();
+    return new _GoogleVision(handle);
+  }
+  /** Authenticate using an API key (synchronous, chainable). */
+  withApiKey(apiKey) {
+    this.handle.withApiKey(apiKey);
+    return this;
+  }
+  /** Authenticate using JWT credentials (asynchronous, chainable). */
+  async withJwt(credentialsJson, scope) {
+    await this.handle.withJwt(credentialsJson, scope);
+    return this;
+  }
+};
+export {
+  GoogleVision
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/runtime.ts","../src/index.ts"],"sourcesContent":["/**\n * Loads the dart2js-compiled runtime and returns the `GoogleVisionJs`\n * namespace installed on `globalThis`. Dispatch is platform-specific — see\n * `browser.ts` and `node.ts` for the actual loader implementations.\n */\n\nimport type { VisionJsNamespace } from './types.js';\n\nlet cached: VisionJsNamespace | undefined;\n\nexport type DartRuntimeLoader = () => Promise<void>;\n\nexport async function getRuntime(\n  loader: DartRuntimeLoader,\n): Promise<VisionJsNamespace> {\n  if (cached) return cached;\n  await loader();\n  const ns = (globalThis as any).GoogleVisionJs as\n    | VisionJsNamespace\n    | undefined;\n  if (!ns) {\n    throw new Error(\n      'google_vision_js runtime failed to initialise: ' +\n        'globalThis.GoogleVisionJs was not installed.',\n    );\n  }\n  cached = ns;\n  return ns;\n}\n","/**\n * google_vision_js — public TypeScript API.\n *\n * This facade wraps the dart2js-compiled `google_vision` core, exposing an\n * idiomatic JavaScript API: Promise-based methods, `image` and `file`\n * sub-APIs that mirror the Dart API shape.\n */\n\nimport type { DartRuntimeLoader } from './runtime.js';\nimport { getRuntime } from './runtime.js';\nimport type {\n  ImageSource,\n  VisionJsHandle,\n} from './types.js';\n\nexport type { ImageSource } from './types.js';\n\n/** Sub-API for image-based Google Vision operations. */\nclass GoogleVisionImage {\n  constructor(private readonly handle: VisionJsHandle) {}\n\n  labelDetection(\n    imageSource: string | ImageSource,\n    maxResults?: number,\n  ): Promise<Record<string, any>[]> {\n    return this.handle.imageLabelDetection(imageSource, maxResults);\n  }\n\n  textDetection(\n    imageSource: string | ImageSource,\n    maxResults?: number,\n  ): Promise<Record<string, any>[]> {\n    return this.handle.imageTextDetection(imageSource, maxResults);\n  }\n\n  faceDetection(\n    imageSource: string | ImageSource,\n    maxResults?: number,\n  ): Promise<Record<string, any>[]> {\n    return this.handle.imageFaceDetection(imageSource, maxResults);\n  }\n\n  safeSearchDetection(\n    imageSource: string | ImageSource,\n    maxResults?: number,\n  ): Promise<Record<string, any> | null> {\n    return this.handle.imageSafeSearchDetection(imageSource, maxResults);\n  }\n\n  cropHints(\n    imageSource: string | ImageSource,\n    maxResults?: number,\n  ): Promise<Record<string, any> | null> {\n    return this.handle.imageCropHints(imageSource, maxResults);\n  }\n\n  documentTextDetection(\n    imageSource: string | ImageSource,\n    maxResults?: number,\n  ): Promise<Record<string, any> | null> {\n    return this.handle.imageDocumentTextDetection(imageSource, maxResults);\n  }\n\n  imageProperties(\n    imageSource: string | ImageSource,\n    maxResults?: number,\n  ): Promise<Record<string, any> | null> {\n    return this.handle.imageProperties(imageSource, maxResults);\n  }\n\n  landmarkDetection(\n    imageSource: string | ImageSource,\n    maxResults?: number,\n  ): Promise<Record<string, any>[]> {\n    return this.handle.imageLandmarkDetection(imageSource, maxResults);\n  }\n\n  logoDetection(\n    imageSource: string | ImageSource,\n    maxResults?: number,\n  ): Promise<Record<string, any>[]> {\n    return this.handle.imageLogoDetection(imageSource, maxResults);\n  }\n\n  objectLocalization(\n    imageSource: string | ImageSource,\n    maxResults?: number,\n  ): Promise<Record<string, any>[]> {\n    return this.handle.imageObjectLocalization(imageSource, maxResults);\n  }\n\n  webDetection(\n    imageSource: string | ImageSource,\n    maxResults?: number,\n  ): Promise<Record<string, any> | null> {\n    return this.handle.imageWebDetection(imageSource, maxResults);\n  }\n}\n\n/** Sub-API for file-based Google Vision operations (PDFs, GCS files). */\nclass GoogleVisionFile {\n  constructor(private readonly handle: VisionJsHandle) {}\n\n  labelDetection(\n    gcsUri: string,\n    maxResults?: number,\n  ): Promise<Record<string, any>[]> {\n    return this.handle.fileLabelDetection(gcsUri, maxResults);\n  }\n\n  textDetection(\n    gcsUri: string,\n    maxResults?: number,\n  ): Promise<Record<string, any>[]> {\n    return this.handle.fileTextDetection(gcsUri, maxResults);\n  }\n\n  documentTextDetection(\n    gcsUri: string,\n    maxResults?: number,\n  ): Promise<Record<string, any>[]> {\n    return this.handle.fileDocumentTextDetection(gcsUri, maxResults);\n  }\n\n  faceDetection(\n    gcsUri: string,\n    maxResults?: number,\n  ): Promise<Record<string, any>[]> {\n    return this.handle.fileFaceDetection(gcsUri, maxResults);\n  }\n}\n\nexport class GoogleVision {\n  readonly image: GoogleVisionImage;\n  readonly file: GoogleVisionFile;\n\n  protected constructor(private readonly handle: VisionJsHandle) {\n    this.image = new GoogleVisionImage(handle);\n    this.file = new GoogleVisionFile(handle);\n  }\n\n  static async create(\n    loader?: DartRuntimeLoader,\n  ): Promise<GoogleVision> {\n    if (!loader) {\n      throw new Error(\n        'No Dart runtime loader provided. Import from ' +\n          \"'@unngh/google-vision/node' or '@unngh/google-vision/browser' instead.\",\n      );\n    }\n    const ns = await getRuntime(loader);\n    const handle = ns.create();\n    return new GoogleVision(handle);\n  }\n\n  /** Authenticate using an API key (synchronous, chainable). */\n  withApiKey(apiKey: string): this {\n    this.handle.withApiKey(apiKey);\n    return this;\n  }\n\n  /** Authenticate using JWT credentials (asynchronous, chainable). */\n  async withJwt(\n    credentialsJson: string,\n    scope?: string,\n  ): Promise<this> {\n    await this.handle.withJwt(credentialsJson, scope);\n    return this;\n  }\n}\n"],"mappings":";AAQA,IAAI;AAIJ,eAAsB,WACpB,QAC4B;AAC5B,MAAI,OAAQ,QAAO;AACnB,QAAM,OAAO;AACb,QAAM,KAAM,WAAmB;AAG/B,MAAI,CAAC,IAAI;AACP,UAAM,IAAI;AAAA,MACR;AAAA,IAEF;AAAA,EACF;AACA,WAAS;AACT,SAAO;AACT;;;ACVA,IAAM,oBAAN,MAAwB;AAAA,EACtB,YAA6B,QAAwB;AAAxB;AAAA,EAAyB;AAAA,EAAzB;AAAA,EAE7B,eACE,aACA,YACgC;AAChC,WAAO,KAAK,OAAO,oBAAoB,aAAa,UAAU;AAAA,EAChE;AAAA,EAEA,cACE,aACA,YACgC;AAChC,WAAO,KAAK,OAAO,mBAAmB,aAAa,UAAU;AAAA,EAC/D;AAAA,EAEA,cACE,aACA,YACgC;AAChC,WAAO,KAAK,OAAO,mBAAmB,aAAa,UAAU;AAAA,EAC/D;AAAA,EAEA,oBACE,aACA,YACqC;AACrC,WAAO,KAAK,OAAO,yBAAyB,aAAa,UAAU;AAAA,EACrE;AAAA,EAEA,UACE,aACA,YACqC;AACrC,WAAO,KAAK,OAAO,eAAe,aAAa,UAAU;AAAA,EAC3D;AAAA,EAEA,sBACE,aACA,YACqC;AACrC,WAAO,KAAK,OAAO,2BAA2B,aAAa,UAAU;AAAA,EACvE;AAAA,EAEA,gBACE,aACA,YACqC;AACrC,WAAO,KAAK,OAAO,gBAAgB,aAAa,UAAU;AAAA,EAC5D;AAAA,EAEA,kBACE,aACA,YACgC;AAChC,WAAO,KAAK,OAAO,uBAAuB,aAAa,UAAU;AAAA,EACnE;AAAA,EAEA,cACE,aACA,YACgC;AAChC,WAAO,KAAK,OAAO,mBAAmB,aAAa,UAAU;AAAA,EAC/D;AAAA,EAEA,mBACE,aACA,YACgC;AAChC,WAAO,KAAK,OAAO,wBAAwB,aAAa,UAAU;AAAA,EACpE;AAAA,EAEA,aACE,aACA,YACqC;AACrC,WAAO,KAAK,OAAO,kBAAkB,aAAa,UAAU;AAAA,EAC9D;AACF;AAGA,IAAM,mBAAN,MAAuB;AAAA,EACrB,YAA6B,QAAwB;AAAxB;AAAA,EAAyB;AAAA,EAAzB;AAAA,EAE7B,eACE,QACA,YACgC;AAChC,WAAO,KAAK,OAAO,mBAAmB,QAAQ,UAAU;AAAA,EAC1D;AAAA,EAEA,cACE,QACA,YACgC;AAChC,WAAO,KAAK,OAAO,kBAAkB,QAAQ,UAAU;AAAA,EACzD;AAAA,EAEA,sBACE,QACA,YACgC;AAChC,WAAO,KAAK,OAAO,0BAA0B,QAAQ,UAAU;AAAA,EACjE;AAAA,EAEA,cACE,QACA,YACgC;AAChC,WAAO,KAAK,OAAO,kBAAkB,QAAQ,UAAU;AAAA,EACzD;AACF;AAEO,IAAM,eAAN,MAAM,cAAa;AAAA,EAId,YAA6B,QAAwB;AAAxB;AACrC,SAAK,QAAQ,IAAI,kBAAkB,MAAM;AACzC,SAAK,OAAO,IAAI,iBAAiB,MAAM;AAAA,EACzC;AAAA,EAHuC;AAAA,EAH9B;AAAA,EACA;AAAA,EAOT,aAAa,OACX,QACuB;AACvB,QAAI,CAAC,QAAQ;AACX,YAAM,IAAI;AAAA,QACR;AAAA,MAEF;AAAA,IACF;AACA,UAAM,KAAK,MAAM,WAAW,MAAM;AAClC,UAAM,SAAS,GAAG,OAAO;AACzB,WAAO,IAAI,cAAa,MAAM;AAAA,EAChC;AAAA;AAAA,EAGA,WAAW,QAAsB;AAC/B,SAAK,OAAO,WAAW,MAAM;AAC7B,WAAO;AAAA,EACT;AAAA;AAAA,EAGA,MAAM,QACJ,iBACA,OACe;AACf,UAAM,KAAK,OAAO,QAAQ,iBAAiB,KAAK;AAChD,WAAO;AAAA,EACT;AACF;","names":[]}