@oino-ts/types 1.0.2 → 1.0.4

package/blob/src/OINOBlobConstants.d.ts

@@ -6,14 +6,12 @@ import type { OINOBlob } from "./OINOBlob.js";
 export type OINOBlobConstructor = new (params: OINOBlobParams) => OINOBlob;
 /** Blob storage connection parameters */
 export type OINOBlobParams = {
-    /** Name of the blob class (e.g. OINOBlobAzureTable) */
+    /** Name of the blob class (e.g. OINOBlobAzure) */
     type: string;
-    /** Blob service endpoint URL */
-    url: string;
     /** Container / bucket name */
     container: string;
-    /** Provider-specific connection string (e.g. Azure Storage connection string or SAS URL) */
-    connectionStr?: string;
+    /** Provider-specific credentials (e.g. Azure Storage connection string or SAS URL) */
+    credentials?: any;
 };
 /** A single blob entry returned by a listing operation */
 export type OINOBlobEntry = {

package/blob/src/OINOBlobFactory.d.ts

@@ -8,8 +8,8 @@ import { OINOBlobApi } from "./OINOBlobApi.js";
  *
  * Usage:
  * ```ts
- * OINOBlobFactory.registerBlob("OINOBlobAzureTable", OINOBlobAzureTable)
- * const blob = await OINOBlobFactory.createBlob({ type: "OINOBlobAzureTable", ... })
+ * OINOBlobFactory.registerBlob("OINOBlobAzure", OINOBlobAzure)
+ * const blob = await OINOBlobFactory.createBlob({ type: "OINOBlobAzure", ... })
  * const api  = await OINOBlobFactory.createApi(blob, { apiName: "files", tableName: "uploads/" })
  * ```
  */

package/blob-aws/src/OINOBlobAwsS3.d.ts

@@ -1,6 +1,5 @@
 import { OINOApi, OINOResult, OINOQueryFilter } from "@oino-ts/common";
-import { OINOBlob } from "@oino-ts/blob";
-import { type OINOBlobEntry, type OINOBlobFetchResult } from "@oino-ts/blob";
+import { OINOBlob, OINOBlobParams, type OINOBlobEntry, type OINOBlobFetchResult } from "@oino-ts/blob";
 /**
  * AWS S3 (and S3-compatible) implementation of `OINOBlob`.
  *
@@ -32,6 +31,7 @@ import { type OINOBlobEntry, type OINOBlobFetchResult } from "@oino-ts/blob";
  */
 export declare class OINOBlobAwsS3 extends OINOBlob {
     private _s3Client;
+    constructor(params: OINOBlobParams);
     /**
      * Initialise the AWS SDK S3 client from the JSON-encoded `connectionStr`.
      * Does not perform any network call.

package/blob-azure/src/OINOBlobAzure.d.ts

@@ -0,0 +1,85 @@
+import { OINOApi, OINOResult, OINOQueryFilter } from "@oino-ts/common";
+import { OINOBlob, OINOBlobParams, type OINOBlobEntry, type OINOBlobFetchResult } from "@oino-ts/blob";
+/**
+ * Azure Blob Storage implementation of `OINOBlob`.
+ *
+ * Authenticates using an Azure Storage connection string.  Connection parameters map as:
+ * - `params.url`           → blob service endpoint, e.g. `https://<account>.blob.core.windows.net`
+ * - `params.container`     → container name
+ * - `params.connectionStr` → Azure Storage connection string (e.g. `DefaultEndpointsProtocol=https;AccountName=...`)
+ *
+ * Register and use via the factory:
+ * ```ts
+ * import { OINOBlobFactory } from "@oino-ts/blob"
+ * import { OINOBlobAzure }   from "@oino-ts/blob-azure"
+ *
+ * OINOBlobFactory.registerBlob("OINOBlobAzure", OINOBlobAzure)
+ *
+ * const blob = await OINOBlobFactory.createBlob({
+ *     type:          "OINOBlobAzure",
+ *     container:     "my-container",
+ *     credentials:   either connectionStr or url and clientId
+ * })
+ * const api = await OINOBlobFactory.createApi(blob, {
+ *     apiName:   "files",
+ *     tableName: "uploads/"   // blob prefix / folder
+ * })
+ * ```
+ */
+export declare class OINOBlobAzure extends OINOBlob {
+    private _containerClient;
+    constructor(params: OINOBlobParams);
+    /**
+     * Initialise the Azure SDK client.  Does not perform any network call.
+     */
+    connect(): Promise<OINOResult>;
+    /**
+     * Verify that the target container exists and is accessible.
+     */
+    validate(): Promise<OINOResult>;
+    /**
+     * Release the client reference (Azure SDK is stateless per-request so nothing to close).
+     */
+    disconnect(): Promise<void>;
+    /**
+     * List all blobs, applying native Azure query filtering where possible and
+     * in-memory result filtering for predicates that cannot be expressed as a
+     * native query.
+     *
+     * - The `name` field supports server-side prefix filtering via the Azure
+     *   `listBlobsFlat` `prefix` option (query filtering).
+     * - All other field predicates (`etag`, `lastModified`, `contentLength`,
+     *   `contentType`) are evaluated in-memory after the listing (result
+     *   filtering).
+     *
+     * @param filter optional query filter to apply
+     */
+    listEntries(filter?: OINOQueryFilter): Promise<OINOBlobEntry[]>;
+    /**
+     * Download the raw content of a named blob.
+     *
+     * @param name full blob name (path within the container)
+     */
+    fetchEntry(name: string): Promise<OINOBlobFetchResult>;
+    /**
+     * Upload (create or replace) a blob with the given binary content.
+     *
+     * @param name full blob name (path within the container)
+     * @param content binary content to store
+     * @param contentType MIME type of the content (e.g. `"image/jpeg"`)
+     */
+    uploadEntry(name: string, content: Uint8Array, contentType: string): Promise<void>;
+    /**
+     * Delete a named blob.
+     *
+     * @param name full blob name (path within the container)
+     */
+    deleteEntry(name: string): Promise<void>;
+    /**
+     * Attach a static `OINOBlobDataModel` to the given API, adding all five
+     * standard fields that Azure Blob Storage returns in a listing.
+     *
+     * @param api the `OINOBlobApi` whose data model is to be initialised
+     */
+    initializeApiDatamodel(api: OINOApi): Promise<void>;
+}

package/blob-azure/src/index.d.ts

@@ -1 +1 @@
-export { OINOBlobAzureTable } from "./OINOBlobAzureTable.js";
+export { OINOBlobAzure } from "./OINOBlobAzure.js";

package/nosql/src/OINONoSqlConstants.d.ts

@@ -8,12 +8,10 @@ export type OINONoSqlConstructor = new (params: OINONoSqlParams) => OINONoSql;
 export type OINONoSqlParams = {
     /** Name of the nosql class (e.g. OINONoSqlAzureTable) */
     type: string;
-    /** Service endpoint URL */
-    url: string;
     /** Table name */
     table: string;
-    /** Provider-specific connection string (e.g. Azure Storage connection string) */
-    connectionStr?: string;
+    /** Provider-specific credentials (e.g. Azure: { url, connectionStr } / AWS: { region, accessKeyId, secretAccessKey, url? }) */
+    credentials?: any;
     /**
      * Optional static partition key.  When set, all read/write operations are
      * automatically scoped to this partition key, allowing multiple logical

package/nosql-aws/src/OINONoSqlAwsDynamo.d.ts

@@ -1,5 +1,5 @@
 import { OINOApi, OINOResult, OINOQueryFilter } from "@oino-ts/common";
-import { OINONoSql } from "@oino-ts/nosql";
+import { OINONoSql, OINONoSqlParams } from "@oino-ts/nosql";
 import { type OINONoSqlEntry } from "@oino-ts/nosql";
 /**
  * Mutable accumulator used while building a DynamoDB expression string.
@@ -96,6 +96,7 @@ export declare class OINONoSqlAwsDynamo extends OINONoSql {
     private _hashKeyAttr;
     /** Actual DynamoDB RANGE key attribute name, discovered during validate(). */
     private _rangeKeyAttr;
+    constructor(params: OINONoSqlParams);
     /**
      * Walk the `OINOQueryFilter` tree and attempt to build a DynamoDB
      * `FilterExpression` string, accumulating placeholder names and values

package/nosql-azure/src/OINONoSqlAzureTable.d.ts

@@ -1,5 +1,5 @@
 import { OINOApi, OINOResult, OINOQueryFilter } from "@oino-ts/common";
-import { OINONoSql } from "@oino-ts/nosql";
+import { OINONoSql, OINONoSqlParams } from "@oino-ts/nosql";
 import { type OINONoSqlEntry } from "@oino-ts/nosql";
 /**
  * Azure Table Storage implementation of `OINONoSql`.
@@ -54,6 +54,7 @@ import { type OINONoSqlEntry } from "@oino-ts/nosql";
  */
 export declare class OINONoSqlAzureTable extends OINONoSql {
     private _tableClient;
+    constructor(params: OINONoSqlParams);
     /**
      * Attempt to translate an `OINOQueryFilter` tree to an Azure Table Storage
      * OData v3 filter expression string.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oino-ts/types",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "OINO TS package for types.",
   "author": "Matias Kiviniemi (pragmatta)",
   "license": "MPL-2.0",