@webda/azure 0.0.0-stage → 4.0.0-beta.13

package/LICENSE

@@ -0,0 +1,166 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
+

package/README.md

@@ -1,3 +1,249 @@
-# Temporary Holding Version
+# @webda/azure module
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+This module is part of Webda Application Framework that allows you to quickly develop applications with all modern prerequisites: Security, Extensibility, GraphQL, REST, CloudNative [https://webda.io](https://webda.io)
+
+<img src="https://webda.io/img/webda.svg" width="128" />
+
+![CI](https://github.com/loopingz/webda.io/workflows/CI/badge.svg)
+
+[![Join the chat at https://gitter.im/loopingz/webda](https://badges.gitter.im/loopingz/webda.svg)](https://gitter.im/loopingz/webda?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![codecov](https://codecov.io/gh/loopingz/webda.io/branch/main/graph/badge.svg?token=8N9DNM3K3O)](https://codecov.io/gh/loopingz/webda.io)
+[![SonarCloud.io](https://sonarcloud.io/api/project_badges/measure?project=loopingz_webda.io&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=loopingz_webda.io)
+![CodeQL](https://github.com/loopingz/webda.io/workflows/CodeQL/badge.svg)
+
+<!-- README_HEADER -->
+
+Azure Blob storage, Cosmos DB, Service Bus, Key Vault, Monitor logging, Container Apps and Functions integrations for Webda.
+
+## Install
+
+```sh
+pnpm add @webda/azure
+```
+
+## Credentials
+
+`getAzureCredential(params)` returns an Azure SDK `TokenCredential`. Complete service-principal parameters select `ClientSecretCredential`; other configurations use `DefaultAzureCredential`, including Azure CLI, managed identity and workload identity authentication.
+
+```typescript
+import { getAzureCredential, loadAzureParameters } from "@webda/azure";
+
+const params = loadAzureParameters({ endpoint: "http://127.0.0.1:10000/devstoreaccount1" });
+const credential = getAzureCredential(params);
+// Pass credential to your Azure SDK client. Use params.endpoint for the service's emulator endpoint.
+```
+
+| Parameter        | Environment fallback    | Purpose                                               |
+| ---------------- | ----------------------- | ----------------------------------------------------- |
+| `tenantId`       | `AZURE_TENANT_ID`       | Microsoft Entra tenant                                |
+| `clientId`       | `AZURE_CLIENT_ID`       | Service principal or user-assigned identity client    |
+| `clientSecret`   | `AZURE_CLIENT_SECRET`   | Service principal secret (`string` or `SecretString`) |
+| `subscriptionId` | `AZURE_SUBSCRIPTION_ID` | Resource subscription                                 |
+| `endpoint`       | —                       | Service-specific endpoint, such as Azurite            |
+
+Service parameter classes implementing `AzureServiceParameters` can call `loadAzureParameters(this)` from `load()`. It fills absent fields and returns the same object, preserving explicit values and encrypted `SecretString` instances. `getAzureCredential` resolves defaults in a copy, so it preserves its input. It forwards the configured tenant/client to the default chain's managed and workload identity options; the SDK also honors its standard authentication environment variables.
+
+Use managed or workload identity for deployed applications, or `az login` for development. To configure a service principal, supply all three of `tenantId`, `clientId` and `clientSecret`. Secrets decrypted by Webda remain wrapped until the SDK constructor needs their plain value. Clear-text secrets emit the existing `SecretString.from` warning, which names the field and never logs its value. Creating a credential performs no token request; the SDK acquires a token when a client needs one.
+
+See Microsoft's [Azure Identity documentation](https://learn.microsoft.com/en-us/javascript/api/overview/azure/identity-readme?view=azure-node-latest) for the SDK's credential chain and environment variables.
+
+## Resource contributions
+
+Services implement `AzureContributor` to describe their ARM resources, container environment, outputs and managed-identity roles. Deployers merge the returned contribution and grant its roles to the application's managed identity.
+
+```typescript
+import type { AzureContributor, AzureDeployerInfo, AzureResourceContribution } from "@webda/azure";
+
+class StorageContribution implements AzureContributor {
+  getAzureResources(deployer: AzureDeployerInfo): AzureResourceContribution {
+    const account = "myappstorage";
+    const scope = `[resourceId('Microsoft.Storage/storageAccounts', '${account}')]`;
+    return {
+      resources: [
+        {
+          type: "Microsoft.Storage/storageAccounts",
+          apiVersion: "2023-05-01",
+          name: account,
+          location: deployer.resources.location,
+          tags: deployer.getDefaultTags(),
+          sku: { name: "Standard_LRS" },
+          kind: "StorageV2"
+        }
+      ],
+      env: { STORAGE_ACCOUNT: account, STORAGE_KEY: { secretRef: "storage-key" } },
+      outputs: { storageAccountId: { type: "string", value: scope } },
+      roleAssignments: [
+        {
+          roleDefinitionId:
+            "[subscriptionResourceId('Microsoft.Authorization/roleDefinitions', 'ba92f5b4-2d11-453d-a403-e96b0029c9fe')]",
+          scope
+        }
+      ]
+    };
+  }
+}
+```
+
+`AzureDeployerInfo` exposes `resources.resourceGroup`, `resources.location`, `resources.subscriptionId`, `getDefaultTags(tags?)` and `getAppPrincipalId()`. Contributors describe resources synchronously; the deployer performs Azure operations. Environment secrets use `{ secretRef }` references to secrets supplied by the deployer.
+
+## Runtime services
+
+Declare these services in `webda.config.jsonc`. All use the credentials above and create SDK clients during initialization.
+
+```jsonc
+{
+  "services": {
+    "Files": {
+      "type": "Webda/AzureBlobBinary",
+      "account": "myappstorage",
+      "container": "files",
+      "models": { "MyApp/Document": ["attachments"] }
+    },
+    "Database": {
+      "type": "Webda/CosmosStore",
+      "endpoint": "https://myapp.documents.azure.com",
+      "database": "webda",
+      "container": "models",
+      "models": ["MyApp/Document"]
+    },
+    "Work": { "type": "Webda/ServiceBusQueue", "namespace": "myapp.servicebus.windows.net", "queue": "work" },
+    "Events": {
+      "type": "Webda/ServiceBusPubSub",
+      "namespace": "myapp.servicebus.windows.net",
+      "topic": "events",
+      "subscription": "api"
+    },
+    "Vault": { "type": "Webda/AzureKeyVault", "vaultUrl": "https://myapp.vault.azure.net" }
+  }
+}
+```
+
+### Blob binaries and content
+
+`AzureBlobBinary` implements `CloudBinary` and registers `azure://container/key` and `azblob://container/key` content URLs. `getContent`, `putContent`, `headContent` and `deleteContent` support streaming, byte ranges, metadata and conditional creation. `prefix` scopes binary keys. `connectionString` accepts a `SecretString`; `endpoint` overrides the configured storage endpoint. `createContainer` defaults to `false`.
+
+Files use `<prefix>/<md5>/data` and exact model/attribute/owner markers. A direct upload has three steps:
+
+1. Send the normal binary challenge (`hash`, `challenge`, `size`, name and MIME type). A verified matching proof attaches an existing file immediately.
+2. PUT bytes to the returned SAS URL with **all returned headers**, including `x-ms-blob-type: BlockBlob` and `Content-MD5`. This SAS only creates an isolated staging blob; it cannot replace shared content.
+3. POST the binary's `complete/{hash}` action. Webda checks the staged bytes, size and proof before publishing and attaching the file. An unfinished or invalid upload never grants access to existing data.
+
+SAS URLs use a shared key when the connection string contains one, or an Entra user delegation key otherwise. The contributor grants Blob Data Contributor on the container and Blob Delegator on the account for signing. Signed URLs and proof values are never logged. `urlExpiry` controls SAS lifetime; `pendingTimeout` limits completion time. Configure a storage lifecycle policy to expire `_staging/` and `_pending/` objects older than that timeout, allowing for the SAS lifetime.
+
+For Azurite, use `connectionString: "UseDevelopmentStorage=true"`, `createContainer: true`, and `serviceVersion: "2023-11-03"` when its supported API version predates the SDK. Development connection strings may also provide a `BlobEndpoint`. Keep the container private.
+
+### Cosmos DB
+
+`CosmosStore` uses the NoSQL API and a serializer envelope to preserve dates, behaviors and concrete model types. `key` accepts a `SecretString`; without it the SDK uses Entra authentication. `createIfNotExists` defaults to `false`; `throughput` optionally configures container RU/s when creating it.
+
+The default partition key is `/id`, with the model primary key encoded as a Cosmos-safe identifier. A custom partition such as `/tenant` must be a top-level field included in the model's primary key. It is immutable with that key. A container's partition definition must match the service setting.
+
+Replace, delete and patches use ETags; stale conditions raise `UpdateConditionFailError`, and missing records raise `StoreNotFoundError`. Patch, increment and remove operations use atomic Cosmos Patch. A change requiring more than ten patch operations fails before writing; use `update()` for larger replacements. Concurrent writes can surface an ETag conflict for the caller to retry.
+
+Supported WebdaQL filters are `=`, `!=`, `<`, `<=`, `>`, `>=`, `IN`, array `CONTAINS`, `LIKE`, `IS NULL`, `IS NOT NULL`, and nested `AND`/`OR`, plus `ORDER BY`, parameters, page limits and opaque continuation tokens. Query values are bound parameters. Cosmos composite indexes may be required for multi-field ordering. Aggregation uses the repository fallback policy; bulk UPDATE and DELETE are explicitly unsupported.
+
+The resource contributor creates the SQL database/container under the account named by `endpoint` and assigns the **Cosmos data-plane** Built-in Data Contributor role. Provision the account itself separately or through the deployer's `customResources`.
+
+### Service Bus
+
+Both services accept `namespace`, optional `connectionString` (`SecretString`), and `createIfNotExists` (default `false`). Queue settings include `queue`, `maxMessages` (10), `maxWaitTimeInMs` (1000), and `maxPendingMessages` (1000).
+
+`ServiceBusQueue` receives in peek-lock mode. Each opaque receipt retains the exact SDK message; `deleteMessage(receipt)` completes it. Failed processing leaves the message available after lock expiry. The pending receipt map is bounded and expired receipts are removed on subsequent receives. Size reports active messages. Long-running manual consumers must finish within the configured Service Bus lock duration.
+
+`ServiceBusPubSub` publishes JSON to `topic`. A configured `subscription` is shared and is never deleted by shutdown. Omitting it creates a unique temporary subscription per consumer with five-minute idle expiry. Successful callbacks complete messages; failed callbacks abandon them. Cancellation waits for receiver creation and closes it, then deletes only its own temporary subscription.
+
+Contributors create messaging entities in an existing namespace and grant Data Sender/Data Receiver. Temporary subscriptions also need topic-scoped Data Owner for their management operations. Runtime `createIfNotExists` needs management privileges; production deployments normally create entities through ARM instead.
+
+### Key Vault configuration and encryption
+
+`AzureKeyVault.getSecret(name)` returns a masked `SecretString`. To load a JSON configuration document, configure `ConfigurationService.sources` as `["Vault:configuration-secret"]`. Within that document, a whole value such as `"${keyvault:database-password}"` resolves to the named secret. Embedded string interpolation is deliberately not supported, so secret wrappers remain intact. ConfigurationService polls for changes.
+
+The module registers the `azure` configuration encrypter before services are created:
+
+```jsonc
+{
+  "parameters": {
+    "configurationEncryption": {
+      "default": "azure",
+      "encrypters": { "azure": { "keyId": "https://myapp.vault.azure.net/keys/configuration" } }
+    }
+  },
+  "services": { "Database": { "key": "encrypt:azure:replace-this" } }
+}
+```
+
+Run `webda config encrypt` to replace the marker with an `crypt:azure:` value. `WEBDA_AZURE_KEY_ID` is the fallback key URL. A random AES-256-GCM key encrypts the value locally and Key Vault wraps that key with RSA-OAEP-256. The envelope pins the vault key version, and tampered values fail authentication. Keep previous key versions enabled while their envelopes remain in use. Decrypted service values stay wrapped until the SDK needs them. The contributor grants Key Vault Secrets User and Crypto User on an existing vault.
+
+### Monitor logs and OpenTelemetry
+
+Container Apps already forwards stdout to Log Analytics. `AzureMonitorLogger` is optional when a custom table is needed:
+
+```json
+{
+  "type": "Webda/AzureMonitorLogger",
+  "endpoint": "https://my-dce.ingest.monitor.azure.com",
+  "ruleId": "dcr-immutable-id",
+  "streamName": "Custom-Webda",
+  "logLevel": "INFO",
+  "batchSize": 100,
+  "flushInterval": 5000,
+  "maxBufferedLogs": 10000
+}
+```
+
+Follow Microsoft's [Logs ingestion setup](https://learn.microsoft.com/en-us/azure/azure-monitor/logs/tutorial-logs-ingestion-portal) to create a Log Analytics custom table, a DCR and (when needed) a DCE. Use the DCR's **immutable** ID, its ingestion stream name, and the DCE or direct DCR ingestion endpoint. Grant the application identity **Monitoring Metrics Publisher** on the DCR. The stream and target table need these columns:
+
+```json
+[
+  { "name": "TimeGenerated", "type": "datetime" },
+  { "name": "Level", "type": "string" },
+  { "name": "Message", "type": "string" }
+]
+```
+
+The logger filters levels, sends serial batches, retains failed records for retry and flushes on stop. Its bounded buffer drops new records when full (`droppedLogs` records the count). Delivery is at least once; retries can duplicate records. `lastDeliveryFailed` is available for health checks, and a failed final flush raises an error after listeners are detached.
+
+For traces and metrics, reuse `@webda/otel` and an OTLP collector with Azure Monitor ingestion. The current Webda OTEL service selects console or OTLP exporters; it does not accept an Azure exporter instance in its configuration. A separately configured Azure Monitor OpenTelemetry SDK/exporter is another option, but avoid initializing competing global SDKs. See Microsoft's [Azure Monitor OpenTelemetry options](https://learn.microsoft.com/en-us/azure/azure-monitor/containers/opentelemetry-options). This package adds no second tracing or metrics implementation.
+
+## Deployers
+
+`Webda/AzureContainerAppsDeployer` builds an OCI image and deploys its digest with ARM. `Webda/AzureFunctionsPackager` creates a deterministic Functions archive, and `Webda/AzureFunctionsDeployer` deploys it to Node 22 Flex Consumption through OneDeploy. See the [Azure deployment guide](https://webda.io/docs/Deployments/Azure).
+
+## Emulator tests
+
+The `Azure emulators` workflow runs Blob uploads against Azurite and Cosmos repository conformance against the Linux emulator. Unit tests use SDK mocks and need no cloud credentials. To run the emulator tests locally, start their containers, trust the Cosmos emulator certificate with `NODE_EXTRA_CA_CERTS`, then run:
+
+```sh
+AZURE_EMULATOR_TESTS=true pnpm --filter @webda/azure exec vitest run src/services/emulators.spec.ts --coverage.enabled=false
+```
+
+Only that test process trusts the emulator certificate; TLS verification remains enabled. The documented emulator account keys are development credentials only.
+
+## Validation
+
+```sh
+pnpm --filter @webda/azure build
+pnpm --filter @webda/azure test
+pnpm --filter @webda/azure lint
+pnpm --filter @webda/azure format
+```
+
+<!-- README_FOOTER -->
+
+## Sponsors
+
+<!--
+Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor](mailto:sponsor@webda.io)
+-->
+
+Arize AI is a machine learning observability and model monitoring platform. It helps you visualize, monitor, and explain your machine learning models. [Learn more](https://arize.com)
+
+[<img src="https://webda.io/img/sponsors/arize.svg" width="200">](https://arize.com)
+
+Loopingz is a software development company that provides consulting and development services. [Learn more](https://loopingz.com)
+
+[<img src="https://webda.io/img/sponsors/loopingz.png" width="200">](https://loopingz.com)
+
+Tellae is an innovative consulting firm specialized in cities transportation issues. We provide our clients, both public and private, with solutions to support your strategic and operational decisions. [Learn more](https://tellae.fr)
+
+[<img src="https://webda.io/img/sponsors/tellae.svg" width="200">](https://tellae.fr)

package/lib/auth.d.ts

@@ -0,0 +1,30 @@
+import type { AccessToken, TokenCredential } from "@azure/core-auth";
+import { AzureServiceParameters } from "./services/azure-parameters.js";
+/** Azure authentication shared by ARM deployment, ACR publishing and OneDeploy. */
+export declare class AzureAuth {
+    protected parameters: AzureServiceParameters;
+    protected credential?: TokenCredential;
+    protected armToken?: AccessToken;
+    /**
+     * Initialize the Azure integration.
+     * @param parameters - Azure authentication or integration parameters
+     */
+    constructor(parameters: AzureServiceParameters);
+    /**
+     * Return the shared Azure SDK credential.
+     * @returns Credential shared by Azure SDK clients
+     */
+    getCredential(): TokenCredential;
+    /**
+     * Acquire or reuse an ARM access token.
+     * @returns Access token for ARM requests
+     */
+    getArmToken(): Promise<string>;
+    /**
+     * Exchange an ARM token for an ACR refresh token.
+     * @param loginServer - ACR login server hostname
+     * @returns ACR refresh token
+     */
+    getAcrRefreshToken(loginServer: string): Promise<string>;
+}
+//# sourceMappingURL=auth.d.ts.map

package/lib/auth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.d.ts","sources":["../src/auth.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAErE,OAAO,EAAE,sBAAsB,EAAsB,MAAM,gCAAgC,CAAC;AAE5F,mFAAmF;AACnF,qBAAa,SAAS;IAOR,SAAS,CAAC,UAAU,EAAE,sBAAsB;IANxD,SAAS,CAAC,UAAU,CAAC,EAAE,eAAe,CAAC;IACvC,SAAS,CAAC,QAAQ,CAAC,EAAE,WAAW,CAAC;IACjC;;;OAGG;IACH,YAAsB,UAAU,EAAE,sBAAsB,EAAI;IAE5D;;;OAGG;IACH,aAAa,IAAI,eAAe,CAE/B;IAED;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC,CAanC;IAED;;;;OAIG;IACG,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CA0B7D;CACF"}

package/lib/auth.js

@@ -0,0 +1,70 @@
+import { WebdaError } from "@webda/core";
+import { getAzureCredential } from "./services/azure-parameters.js";
+/** Azure authentication shared by ARM deployment, ACR publishing and OneDeploy. */
+export class AzureAuth {
+    /**
+     * Initialize the Azure integration.
+     * @param parameters - Azure authentication or integration parameters
+     */
+    constructor(parameters) {
+        this.parameters = parameters;
+    }
+    /**
+     * Return the shared Azure SDK credential.
+     * @returns Credential shared by Azure SDK clients
+     */
+    getCredential() {
+        return (this.credential ?? (this.credential = getAzureCredential(this.parameters)));
+    }
+    /**
+     * Acquire or reuse an ARM access token.
+     * @returns Access token for ARM requests
+     */
+    async getArmToken() {
+        try {
+            if (!this.armToken || this.armToken.expiresOnTimestamp < Date.now() + 60000) {
+                this.armToken = (await this.getCredential().getToken("https://management.azure.com/.default")) ?? undefined;
+            }
+            if (!this.armToken)
+                throw new Error();
+            return this.armToken.token;
+        }
+        catch {
+            throw new WebdaError.CodeError("AZURE_AUTH", "Azure authentication failed: run az login or configure AZURE_CLIENT_ID, AZURE_TENANT_ID and AZURE_CLIENT_SECRET");
+        }
+    }
+    /**
+     * Exchange an ARM token for an ACR refresh token.
+     * @param loginServer - ACR login server hostname
+     * @returns ACR refresh token
+     */
+    async getAcrRefreshToken(loginServer) {
+        if (!/^[a-zA-Z0-9-]+\.azurecr\.(?:io|cn|us)$/.test(loginServer))
+            throw new WebdaError.BadRequest("ACR token exchange requires an Azure Container Registry login server");
+        const body = new URLSearchParams({
+            grant_type: "access_token",
+            service: loginServer,
+            access_token: await this.getArmToken()
+        });
+        if (this.parameters.tenantId)
+            body.set("tenant", this.parameters.tenantId);
+        try {
+            const response = await fetch(`https://${loginServer}/oauth2/exchange`, {
+                method: "POST",
+                body,
+                redirect: "error",
+                signal: AbortSignal.timeout(30000)
+            });
+            if (!response.ok)
+                throw new Error();
+            const result = (await response.json());
+            if (!result.refresh_token)
+                throw new Error();
+            return result.refresh_token;
+        }
+        catch {
+            throw new WebdaError.CodeError("AZURE_ACR_AUTH", "ACR token exchange failed; check the identity's registry push permissions");
+        }
+    }
+}
+//# sourceMappingURL=auth.js.map

package/lib/auth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.js","sources":["../src/auth.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAA0B,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAE5F,mFAAmF;AACnF,MAAM,OAAO,SAAS;IAGpB;;;OAGG;IACH,YAAsB,UAAkC;0BAAlC,UAAU;IAA2B,CAAC;IAE5D;;;OAGG;IACH,aAAa;QACX,OAAO,CAAC,IAAI,CAAC,UAAU,KAAf,IAAI,CAAC,UAAU,GAAK,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,EAAC,CAAC;IACnE,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW;QACf,IAAI,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,kBAAkB,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,EAAE,CAAC;gBAC5E,IAAI,CAAC,QAAQ,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC,QAAQ,CAAC,uCAAuC,CAAC,CAAC,IAAI,SAAS,CAAC;YAC9G,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,QAAQ;gBAAE,MAAM,IAAI,KAAK,EAAE,CAAC;YACtC,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAC7B,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,UAAU,CAAC,SAAS,CAC5B,YAAY,EACZ,iHAAiH,CAClH,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,kBAAkB,CAAC,WAAmB;QAC1C,IAAI,CAAC,wCAAwC,CAAC,IAAI,CAAC,WAAW,CAAC;YAC7D,MAAM,IAAI,UAAU,CAAC,UAAU,CAAC,sEAAsE,CAAC,CAAC;QAC1G,MAAM,IAAI,GAAG,IAAI,eAAe,CAAC;YAC/B,UAAU,EAAE,cAAc;YAC1B,OAAO,EAAE,WAAW;YACpB,YAAY,EAAE,MAAM,IAAI,CAAC,WAAW,EAAE;SACvC,CAAC,CAAC;QACH,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ;YAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAC3E,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,WAAW,WAAW,kBAAkB,EAAE;gBACrE,MAAM,EAAE,MAAM;gBACd,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC;aACnC,CAAC,CAAC;YACH,IAAI,CAAC,QAAQ,CAAC,EAAE;gBAAE,MAAM,IAAI,KAAK,EAAE,CAAC;YACpC,MAAM,MAAM,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA+B,CAAC;YACrE,IAAI,CAAC,MAAM,CAAC,aAAa;gBAAE,MAAM,IAAI,KAAK,EAAE,CAAC;YAC7C,OAAO,MAAM,CAAC,aAAa,CAAC;QAC9B,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,UAAU,CAAC,SAAS,CAC5B,gBAAgB,EAChB,2EAA2E,CAC5E,CAAC;QACJ,CAAC;IACH,CAAC;CACF"}

package/lib/deployers/arm.service.d.ts

@@ -0,0 +1,108 @@
+import { SecretString } from "@webda/core";
+import { ContainerDeployer, ContainerDeployerParameters } from "@webda/oci";
+import { AzureServiceParameters } from "../services/azure-parameters.js";
+import { AzureDeployerInfo, AzureRoleAssignment } from "../services/contributors.js";
+import { AzureTemplate } from "../template.js";
+/** Shared ARM and OCI parameters used by Azure deployment units. */
+export declare class AzureArmDeployerParameters extends ContainerDeployerParameters implements AzureServiceParameters {
+    tenantId?: string;
+    clientId?: string;
+    clientSecret?: string | SecretString;
+    subscriptionId: string;
+    endpoint?: string;
+    resourceGroup: string;
+    location: string;
+    createResourceGroup: boolean;
+    deploymentName?: string;
+    resourceTags: Record<string, string>;
+    customResources: Record<string, any>[] | Record<string, Record<string, any>>;
+    templateOutput?: string;
+    /**
+     * Perform load.
+     * @override
+     */
+    load(params?: any): this;
+}
+/** Deployment results contain resource endpoints, never tokens or secret parameter values. */
+export interface AzureDeployResult {
+    image?: string;
+    digest?: string;
+    fqdn?: string;
+    revision?: string;
+    outputs: Record<string, any>;
+}
+/** Shared template collection and ARM deployment. SDK clients are created only when deploying. */
+export declare abstract class AzureArmDeployer<T extends AzureArmDeployerParameters = AzureArmDeployerParameters> extends ContainerDeployer<T, AzureDeployResult> implements AzureDeployerInfo {
+    resources: T;
+    template: AzureTemplate;
+    result?: AzureDeployResult;
+    protected secretValues: Map<string, string | SecretString>;
+    protected contributedEnv: Record<string, string | {
+        secretRef: string;
+    }>;
+    protected roles: AzureRoleAssignment[];
+    /**
+     * Perform get resolved parameters.
+     * @override
+     */
+    getResolvedParameters(): T;
+    /**
+     * Resolve the deployment scope and reset template state.
+     */
+    protected prepare(): void;
+    /**
+     * Merge deployment tags with resource tags.
+     * @param tags - Resource-specific tags
+     * @returns The default tags result
+     */
+    getDefaultTags(tags?: Record<string, string>): Record<string, string>;
+    abstract getAppResourceId(): string;
+    /**
+     * Return the managed identity resource identifier.
+     * @returns The identity resource id result
+     */
+    protected getIdentityResourceId(): string;
+    /**
+     * Return the ARM expression for the application principal.
+     * @returns The app principal id result
+     */
+    abstract getAppPrincipalId(): string;
+    abstract generateTemplate(image?: string): AzureTemplate;
+    /**
+     * Add a secret without placing its value in the serializable template.
+     * @param value - Value to convert or protect
+     * @returns The secure parameter result
+     */
+    protected secureParameter(value: string | SecretString): string;
+    /**
+     * Merge service resources, environment and roles. Conflicting contributions are rejected.
+     */
+    Resources(): void;
+    /**
+     * Add a resource, rejecting conflicting declarations.
+     * @param resource - ARM resource declaration
+     */
+    protected addResource(resource: Record<string, any>): void;
+    /**
+     * Grant every contributed role to one application or job identity.
+     * @param principalId - ARM principal identifier expression
+     * @param identityResourceId - Resource providing the managed identity
+     */
+    protected grantRoles(principalId?: string, identityResourceId?: string): void;
+    /**
+     * Write a reviewable ARM template; this command never builds, pushes or deploys.
+     * @param output - Optional template output path
+     * @returns Generated ARM template
+     */
+    generate(output?: string): Promise<AzureTemplate>;
+    /** Save the current template with secure parameters left as references.
+     * @param output - Optional template output path
+     */
+    protected writeTemplate(output?: string): void;
+    /**
+     * Deploy the ARM template with secure parameter values.
+     * @returns Deployment outputs
+     */
+    sendTemplate(): Promise<Record<string, any>>;
+}
+//# sourceMappingURL=arm.service.d.ts.map

package/lib/deployers/arm.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"arm.service.d.ts","sources":["../../src/deployers/arm.service.ts"],"names":[],"mappings":"AAEA,OAAO,EAAW,YAAY,EAAuC,MAAM,aAAa,CAAC;AACzF,OAAO,EAAE,iBAAiB,EAAE,2BAA2B,EAAE,MAAM,YAAY,CAAC;AAI5E,OAAO,EAAE,sBAAsB,EAAuB,MAAM,iCAAiC,CAAC;AAC9F,OAAO,EAAoB,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AACvG,OAAO,EAAY,aAAa,EAAmC,MAAM,gBAAgB,CAAC;AAE1F,oEAAoE;AACpE,qBAAa,0BAA2B,SAAQ,2BAA4B,YAAW,sBAAsB;IAC3G,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,GAAG,YAAY,CAAC;IACrC,cAAc,EAAG,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,EAAG,MAAM,CAAC;IACvB,QAAQ,SAAgB;IACxB,mBAAmB,UAAS;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAA8E;IAClH,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAM;IAClF,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,IAAI,CAAC,MAAM,GAAE,GAAQ,GAAG,IAAI,CAG3B;CACF;AAED,8FAA8F;AAC9F,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC9B;AAkBD,kGAAkG;AAClG,8BAAsB,gBAAgB,CAAC,CAAC,SAAS,0BAA0B,GAAG,0BAA0B,CACtG,SAAQ,iBAAiB,CAAC,CAAC,EAAE,iBAAiB,CAC9C,YAAW,iBAAiB;IAE5B,SAAS,EAAG,CAAC,CAAC;IACd,QAAQ,EAAE,aAAa,CAAyB;IAChD,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,SAAS,CAAC,YAAY,qCAA4C;IAClE,SAAS,CAAC,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC,CAAM;IAC9E,SAAS,CAAC,KAAK,EAAE,mBAAmB,EAAE,CAAM;IAE5C;;;OAGG;IACH,qBAAqB,IAAI,CAAC,CAEzB;IAED;;OAEG;IACH,SAAS,CAAC,OAAO,IAAI,IAAI,CAUxB;IAED;;;;OAIG;IACH,cAAc,CAAC,IAAI,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAExE;IACD,QAAQ,CAAC,gBAAgB,IAAI,MAAM,CAAC;IACpC;;;OAGG;IACH,SAAS,CAAC,qBAAqB,IAAI,MAAM,CAExC;IACD;;;OAGG;IACH,QAAQ,CAAC,iBAAiB,IAAI,MAAM,CAAC;IACrC,QAAQ,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;IAEzD;;;;OAIG;IACH,SAAS,CAAC,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,GAAG,MAAM,CAK9D;IAED;;OAEG;IACH,SAAS,IAAI,IAAI,CAmBhB;IAED;;;OAGG;IACH,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAWzD;IAED;;;;OAIG;IACH,SAAS,CAAC,UAAU,CAClB,WAAW,SAA2B,EACtC,kBAAkB,SAA+B,GAChD,IAAI,CAsBN;IAED;;;;OAIG;IAEG,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAItD;IAED;;OAEG;IACH,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAO7C;IAED;;;OAGG;IACG,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CA0CjD;CACF"}