@azure/eventgrid-namespaces 1.0.0-alpha.20240412.4

package/package.json

@@ -0,0 +1,120 @@
+{
+  "name": "@azure/eventgrid-namespaces",
+  "sdk-type": "client",
+  "author": "Microsoft Corporation",
+  "description": "An isomorphic client library for the Azure Event Grid service.",
+  "version": "1.0.0-alpha.20240412.4",
+  "keywords": [
+    "node",
+    "azure",
+    "typescript",
+    "browser",
+    "isomorphic",
+    "cloud"
+  ],
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "module": "./dist-esm/src/index.js",
+  "types": "./types/eventgrid-namespaces.d.ts",
+  "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/eventgrid/eventgrid-namespaces/README.md",
+  "repository": "github:Azure/azure-sdk-for-js",
+  "bugs": {
+    "url": "https://github.com/Azure/azure-sdk-for-js/issues"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "dist/",
+    "dist-esm/src/",
+    "types/eventgrid-namespaces.d.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "//sampleConfiguration": {
+    "productName": "Azure Event Grid",
+    "productSlugs": [
+      "azure",
+      "azure-event-grid"
+    ],
+    "requiredResources": {
+      "Azure Event Grid Custom Topic, configured to use the Event Grid Schema": "https://docs.microsoft.com/azure/event-grid/scripts/event-grid-cli-create-custom-topic",
+      "Azure Event Grid Custom Topic, configured to use the Cloud Event 1.0 Schema": "https://docs.microsoft.com/azure/event-grid/scripts/event-grid-cli-create-custom-topic",
+      "Azure Service Bus Queue": "https://docs.microsoft.com/azure/service-bus-messaging/service-bus-quickstart-portal"
+    }
+  },
+  "scripts": {
+    "audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit",
+    "build:browser": "tsc -p . && dev-tool run bundle",
+    "build:node": "tsc -p . && dev-tool run bundle",
+    "build:samples": "echo Obsolete",
+    "build:test": "tsc -p . && dev-tool run bundle",
+    "build": "npm run clean && tsc -p . && dev-tool run bundle && api-extractor run --local",
+    "check-format": "dev-tool run vendored prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"samples-dev/**/*.ts\" \"*.{js,json}\"",
+    "clean": "rimraf --glob dist dist-browser dist-esm dist-test temp types *.tgz *.log",
+    "execute:samples": "dev-tool samples run samples-dev",
+    "extract-api": "tsc -p . && api-extractor run --local",
+    "format": "dev-tool run vendored prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"samples-dev/**/*.ts\" \"*.{js,json}\"",
+    "integration-test:browser": "dev-tool run test:browser",
+    "integration-test:node": "dev-tool run test:node-js-input -- --timeout 5000000 \"dist-esm/test/**/*.spec.js\"",
+    "integration-test": "npm run integration-test:node && npm run integration-test:browser",
+    "lint:fix": "eslint package.json api-extractor.json README.md src test --ext .ts,.javascript,.js --fix --fix-type [problem,suggestion]",
+    "lint": "eslint package.json api-extractor.json README.md src test --ext .ts,.javascript,.js",
+    "pack": "npm pack 2>&1",
+    "test:browser": "npm run clean && npm run build:test && npm run unit-test:browser",
+    "test:node": "npm run clean && npm run build:test && npm run unit-test:node",
+    "test": "npm run clean && npm run build:test && npm run unit-test",
+    "unit-test:browser": "dev-tool run test:browser",
+    "unit-test:node": "dev-tool run test:node-tsx-ts -- --timeout 1200000 'test/**/*.spec.ts'",
+    "unit-test": "npm run unit-test:node && npm run unit-test:browser"
+  },
+  "sideEffects": false,
+  "autoPublish": false,
+  "dependencies": {
+    "@azure/core-auth": "^1.7.0",
+    "@azure/core-rest-pipeline": "^1.1.3",
+    "@azure-rest/core-client": "^1.3.1",
+    "@azure/logger": "^1.0.0",
+    "@azure/core-util": "^1.6.1",
+    "buffer": "^6.0.0",
+    "tslib": "^2.2.0"
+  },
+  "devDependencies": {
+    "@azure/identity": "^4.1.0",
+    "@azure/core-client": "^1.5.0",
+    "@azure/dev-tool": ">=1.0.0-alpha <1.0.0-alphb",
+    "@azure/eslint-plugin-azure-sdk": ">=3.0.0-alpha <3.0.0-alphb",
+    "@azure/service-bus": "^7.0.0",
+    "@azure/test-utils": ">=1.0.0-alpha <1.0.0-alphb",
+    "@azure-tools/test-recorder": "^3.0.0",
+    "@microsoft/api-extractor": "^7.31.1",
+    "@types/chai": "^4.1.6",
+    "@types/chai-as-promised": "^7.1.0",
+    "@types/mocha": "^10.0.0",
+    "@types/node": "^18.0.0",
+    "@types/sinon": "^17.0.0",
+    "@types/uuid": "^8.0.0",
+    "chai": "^4.2.0",
+    "chai-as-promised": "^7.1.1",
+    "cross-env": "^7.0.2",
+    "dotenv": "^16.0.0",
+    "eslint": "^8.0.0",
+    "karma": "^6.2.0",
+    "karma-chrome-launcher": "^3.0.0",
+    "karma-coverage": "^2.0.0",
+    "karma-env-preprocessor": "^0.1.1",
+    "karma-firefox-launcher": "^1.1.0",
+    "karma-junit-reporter": "^2.0.1",
+    "karma-mocha": "^2.0.1",
+    "karma-mocha-reporter": "^2.2.5",
+    "karma-sourcemap-loader": "^0.3.8",
+    "mocha": "^10.0.0",
+    "c8": "^9.1.0",
+    "prettier": "^2.5.1",
+    "rimraf": "^5.0.5",
+    "sinon": "^17.0.0",
+    "source-map-support": "^0.5.9",
+    "ts-node": "^10.0.0",
+    "typescript": "~5.3.3"
+  }
+}

package/types/eventgrid-namespaces.d.ts

@@ -0,0 +1,275 @@
+import { AzureKeyCredential } from '@azure/core-auth';
+import { ClientOptions } from '@azure-rest/core-client';
+import { ErrorModel } from '@azure-rest/core-client';
+import { OperationOptions } from '@azure-rest/core-client';
+import { TokenCredential } from '@azure/core-auth';
+
+export declare interface AcknowledgeCloudEventsOptions extends OperationOptions {
+}
+
+/** The result of the Acknowledge operation. */
+export declare interface AcknowledgeResult {
+    /** Array of FailedLockToken for failed cloud events. Each FailedLockToken includes the lock token along with the related error information (namely, the error code and description). */
+    failedLockTokens: FailedLockToken[];
+    /** Array of lock tokens for the successfully acknowledged cloud events. */
+    succeededLockTokens: string[];
+}
+
+export { AzureKeyCredential }
+
+/** Properties of the Event Broker operation. */
+export declare interface BrokerProperties {
+    /** The token of the lock on the event. */
+    lockToken: string;
+    /** The attempt count for delivering the event. */
+    deliveryCount: number;
+}
+
+/**
+ * An event in the Cloud Event 1.0 schema.
+ */
+export declare interface CloudEvent<T> {
+    /**
+     * Type of event related to the originating occurrence.
+     */
+    type: string;
+    /**
+     * Identifies the context in which an event happened. The combination of id and source must be unique for each distinct event.
+     */
+    source: string;
+    /**
+     * An identifier for the event. The combination of id and source must be unique for each distinct event.
+     */
+    id: string;
+    /**
+     * The time the event was generated.
+     */
+    time?: Date;
+    /**
+     * Identifies the schema that data adheres to.
+     */
+    dataschema?: string;
+    /**
+     * Content type of data value.
+     */
+    datacontenttype?: string;
+    /**
+     * Event data specific to the event type.
+     */
+    data?: T;
+    /**
+     * This describes the subject of the event in the context of the event producer (identified by source).
+     */
+    subject?: string;
+    /**
+     * Additional context attributes for the event. The Cloud Event specification refers to these as "extension attributes".
+     */
+    extensionAttributes?: Record<string, unknown>;
+    /**
+     * The version of the CloudEvents specification which the event uses.
+     */
+    specversion?: string | "1.0";
+}
+
+/** Properties of an event published to an Azure Messaging EventGrid Namespace topic using the CloudEvent 1.0 Schema. */
+declare interface CloudEvent_2 {
+    /** An identifier for the event. The combination of id and source must be unique for each distinct event. */
+    id: string;
+    /** Identifies the context in which an event happened. The combination of id and source must be unique for each distinct event. */
+    source: string;
+    /** Event data specific to the event type. */
+    data?: unknown;
+    /** Event data specific to the event type, encoded as a base64 string. */
+    dataBase64?: Uint8Array;
+    /** Type of event related to the originating occurrence. */
+    type: string;
+    /** The time (in UTC) the event was generated, in RFC3339 format. */
+    time?: Date;
+    /** The version of the CloudEvents specification which the event uses. */
+    specversion: string;
+    /** Identifies the schema that data adheres to. */
+    dataschema?: string;
+    /** Content type of data value. */
+    datacontenttype?: string;
+    /** This describes the subject of the event in the context of the event producer (identified by source). */
+    subject?: string;
+}
+
+/**
+ * Event Grid Namespaces Client
+ */
+export declare class EventGridClient {
+    private _client;
+    /** Azure Messaging EventGrid Client */
+    constructor(endpoint: string, credential: AzureKeyCredential | TokenCredential, options?: EventGridClientOptions);
+    /**
+     * Publish Single Cloud Event to namespace topic. In case of success, the server responds with an HTTP 200
+     * status code with an empty JSON object in response. Otherwise, the server can return various error codes.
+     * For example, 401: which indicates authorization failure, 403: which indicates quota exceeded or message
+     * is too large, 410: which indicates that specific topic is not found, 400: for bad request, and 500: for
+     * internal server error.
+     *
+     * @param event - Event to publish
+     * @param topicName - Topic to publish the event
+     * @param options - Options to publish
+     *
+     */
+    publishCloudEvent<T>(event: CloudEvent<T>, topicName: string, options?: PublishCloudEventOptions): Promise<void>;
+    /**
+     * Publish Batch Cloud Event to namespace topic. In case of success, the server responds with an HTTP 200
+     * status code with an empty JSON object in response. Otherwise, the server can return various error codes.
+     * For example, 401: which indicates authorization failure, 403: which indicates quota exceeded or message
+     * is too large, 410: which indicates that specific topic is not found, 400: for bad request, and 500: for
+     * internal server error.
+     *
+     * @param events - Events to publish
+     * @param topicName - Topic to publish the event
+     * @param options - Options to publish
+     *
+     */
+    publishCloudEvents<T>(events: CloudEvent<T>[], topicName: string, options?: PublishCloudEventsOptions): Promise<void>;
+    /**
+     * Receive Batch of Cloud Events from the Event Subscription.
+     *
+     * @param topicName - Topic to receive
+     * @param eventSubscriptionName - Name of the Event Subscription
+     * @param options - Options to receive
+     *
+     */
+    receiveCloudEvents(topicName: string, eventSubscriptionName: string, options?: ReceiveCloudEventsOptions): Promise<ReceiveResult>;
+    /**
+     * Acknowledge batch of Cloud Events. The server responds with an HTTP 200 status code if at least one
+     * event is successfully acknowledged. The response body will include the set of successfully acknowledged
+     * lockTokens, along with other failed lockTokens with their corresponding error information. Successfully
+     * acknowledged events will no longer be available to any consumer.
+     *
+     * @param lockTokens - Lock Tokens
+     * @param topicName - Topic Name
+     * @param eventSubscriptionName - Name of the Event Subscription
+     * @param options - Options to Acknowledge
+     *
+     */
+    acknowledgeCloudEvents(lockTokens: string[], topicName: string, eventSubscriptionName: string, options?: AcknowledgeCloudEventsOptions): Promise<AcknowledgeResult>;
+    /**
+     * Release batch of Cloud Events. The server responds with an HTTP 200 status code if at least one event is
+     * successfully released. The response body will include the set of successfully released lockTokens, along
+     * with other failed lockTokens with their corresponding error information.
+     *
+     * @param lockTokens - Lock Tokens
+     * @param topicName - Topic Name
+     * @param eventSubscriptionName - Name of the Event Subscription
+     * @param options - Options to release
+     *
+     */
+    releaseCloudEvents(lockTokens: string[], topicName: string, eventSubscriptionName: string, options?: ReleaseCloudEventsOptions): Promise<ReleaseResult>;
+    /**
+     * Reject batch of Cloud Events.
+     *
+     * @param lockTokens - Lock Tokens
+     * @param topicName - Topic Name
+     * @param eventSubscriptionName - Name of the Event Subscription
+     * @param options - Options to reject
+     *
+     */
+    rejectCloudEvents(lockTokens: string[], topicName: string, eventSubscriptionName: string, options?: RejectCloudEventsOptions): Promise<RejectResult>;
+    /**
+     * Renew lock for batch of Cloud Events.
+     *
+     * @param lockTokens - Lock Tokens
+     * @param topicName - Topic Name
+     * @param eventSubscriptionName - Name of the Event Subscription
+     * @param options - Options to renew
+     */
+    renewCloudEventLocks(lockTokens: string[], topicName: string, eventSubscriptionName: string, options?: RenewCloudEventLocksOptions): Promise<RenewCloudEventLocksResult>;
+}
+
+export declare interface EventGridClientOptions extends ClientOptions {
+}
+
+/** Failed LockToken information. */
+export declare interface FailedLockToken {
+    /** The lock token of an entry in the request. */
+    lockToken: string;
+    /** Error information of the failed operation result for the lock token in the request. */
+    error: ErrorModel;
+}
+
+export { OperationOptions }
+
+export declare interface PublishCloudEventOptions extends OperationOptions {
+    /** binary mode */
+    binaryMode?: boolean;
+    /** content type */
+    contentType?: string;
+}
+
+export declare interface PublishCloudEventsOptions extends OperationOptions {
+    /** content type */
+    contentType?: string;
+}
+
+/** The result of the Publish operation. */
+export declare interface PublishResultOutput {
+}
+
+export declare interface ReceiveCloudEventsOptions extends OperationOptions {
+    /** Max Events count to be received. Minimum value is 1, while maximum value is 100 events. If not specified, the default value is 1. */
+    maxEvents?: number;
+    /** Max wait time value for receive operation in Seconds. It is the time in seconds that the server approximately waits for the availability of an event and responds to the request. If an event is available, the broker responds immediately to the client. Minimum value is 10 seconds, while maximum value is 120 seconds. If not specified, the default value is 60 seconds. */
+    maxWaitTime?: number;
+}
+
+/** Receive operation details per Cloud Event. */
+export declare interface ReceiveDetails {
+    /** The Event Broker details. */
+    brokerProperties: BrokerProperties;
+    /** Cloud Event details. */
+    event: CloudEvent_2;
+}
+
+/** Details of the Receive operation response. */
+export declare interface ReceiveResult {
+    /** Array of receive responses, one per cloud event. */
+    value: ReceiveDetails[];
+}
+
+export declare interface RejectCloudEventsOptions extends OperationOptions {
+}
+
+/** The result of the Reject operation. */
+export declare interface RejectResult {
+    /** Array of FailedLockToken for failed cloud events. Each FailedLockToken includes the lock token along with the related error information (namely, the error code and description). */
+    failedLockTokens: FailedLockToken[];
+    /** Array of lock tokens for the successfully rejected cloud events. */
+    succeededLockTokens: string[];
+}
+
+export declare interface ReleaseCloudEventsOptions extends OperationOptions {
+    /** Release cloud events with the specified delay in seconds. */
+    releaseDelayInSeconds?: ReleaseDelay;
+}
+
+/** Supported delays for release operation. */
+/** "0", "10", "60", "600", "3600" */
+export declare type ReleaseDelay = string;
+
+/** The result of the Release operation. */
+export declare interface ReleaseResult {
+    /** Array of FailedLockToken for failed cloud events. Each FailedLockToken includes the lock token along with the related error information (namely, the error code and description). */
+    failedLockTokens: FailedLockToken[];
+    /** Array of lock tokens for the successfully released cloud events. */
+    succeededLockTokens: string[];
+}
+
+export declare interface RenewCloudEventLocksOptions extends OperationOptions {
+}
+
+/** The result of the RenewLock operation. */
+export declare interface RenewCloudEventLocksResult {
+    /** Array of FailedLockToken for failed cloud events. Each FailedLockToken includes the lock token along with the related error information (namely, the error code and description). */
+    failedLockTokens: FailedLockToken[];
+    /** Array of lock tokens for the successfully renewed locks. */
+    succeededLockTokens: string[];
+}
+
+export { }