@peterhauge/apiops-cli 0.2.1-alpha.0 → 0.3.0-alpha.0

package/dist/templates/azure-devops/publish-pipeline.js

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 /**
- * T046: Azure DevOps publish pipeline template
+ * Azure DevOps publish pipeline template
  * Multi-stage pipeline with commit ID choice, environment selection, and variable groups
  */
 export function generatePublishPipeline(config) {
@@ -9,121 +9,121 @@ export function generatePublishPipeline(config) {
     const envValues = config.environments.map((env) => `      - '${env}'`).join('\n');
     const stages = config.environments.map((env) => {
         const envUpper = env.toUpperCase();
-        return `- stage: Publish_${env}
-  displayName: 'Publish to ${env}'
-  condition: eq('\${{ parameters.ENVIRONMENT }}', '${env}')
-  variables:
-    - group: apim-${env}
-  jobs:
-    - deployment: Deploy
-      displayName: 'Deploy to ${env}'
-      environment: ${env}
-      pool:
-        vmImage: 'ubuntu-latest'
-      strategy:
-        runOnce:
-          deploy:
-            steps:
-              - checkout: self
-                fetchDepth: 2
-
-              - task: UseNode@1
-                displayName: 'Setup Node.js'
-                inputs:
-                  version: '22.x'
-
-              - script: |
-                  node -v
-                  npm -v
-                displayName: 'Verify Node.js version'
-
-              - script: |
-                  if [[ -f package-lock.json || -f npm-shrinkwrap.json ]]; then
-                    npm ci
-                  else
-                    npm install
-                  fi
-                displayName: 'Install dependencies'
-
-              - task: replacetokens@6
-                displayName: 'Substitute tokens in configuration.${env}.yaml'
-                inputs:
-                  sources: 'configuration.${env}.yaml'
-                  tokenPattern: 'custom'
-                  tokenPrefix: '{#['
-                  tokenSuffix: ']#}'
-                  missingVarAction: 'keep'
-
-              - script: |
-                  if grep -q '{#\\[' configuration.${env}.yaml; then
-                    echo "Unresolved tokens remain in configuration.${env}.yaml"
-                    grep -o '{#\\[[^]]*\\]#}' configuration.${env}.yaml | sort -u
-                    exit 1
-                  fi
-                displayName: 'Validate token substitution (${env})'
-
-              - task: AzureCLI@2
-                displayName: 'Publish to ${env} (incremental - last commit only)'
-                condition: ne('\${{ parameters.COMMIT_ID_CHOICE }}', 'publish-all-artifacts-in-repo')
-                inputs:
-                  azureSubscription: 'AZURE_SERVICE_CONNECTION_${envUpper}'
-                  scriptType: 'bash'
-                  scriptLocation: 'inlineScript'
-                  inlineScript: |
-                    npx apiops publish \\
-                      --resource-group $(APIM_RESOURCE_GROUP_${envUpper}) \\
-                      --service-name $(APIM_SERVICE_NAME_${envUpper}) \\
-                      --source ${config.artifactDir} \\
-                      --overrides configuration.${env}.yaml \\
-                      --commit-id $(Build.SourceVersion) \\
-                      --subscription-id $(AZURE_SUBSCRIPTION_ID)
-
-              - task: AzureCLI@2
-                displayName: 'Publish to ${env} (all artifacts)'
-                condition: eq('\${{ parameters.COMMIT_ID_CHOICE }}', 'publish-all-artifacts-in-repo')
-                inputs:
-                  azureSubscription: 'AZURE_SERVICE_CONNECTION_${envUpper}'
-                  scriptType: 'bash'
-                  scriptLocation: 'inlineScript'
-                  inlineScript: |
-                    npx apiops publish \\
-                      --resource-group $(APIM_RESOURCE_GROUP_${envUpper}) \\
-                      --service-name $(APIM_SERVICE_NAME_${envUpper}) \\
-                      --source ${config.artifactDir} \\
-                      --overrides configuration.${env}.yaml \\
-                      --subscription-id $(AZURE_SUBSCRIPTION_ID)
+        return `- stage: Publish_${env}
+  displayName: 'Publish to ${env}'
+  condition: eq('\${{ parameters.ENVIRONMENT }}', '${env}')
+  variables:
+    - group: apim-${env}
+  jobs:
+    - deployment: Deploy
+      displayName: 'Deploy to ${env}'
+      environment: ${env}
+      pool:
+        vmImage: 'ubuntu-latest'
+      strategy:
+        runOnce:
+          deploy:
+            steps:
+              - checkout: self
+                fetchDepth: 2
+
+              - task: UseNode@1
+                displayName: 'Setup Node.js'
+                inputs:
+                  version: '22.x'
+
+              - script: |
+                  node -v
+                  npm -v
+                displayName: 'Verify Node.js version'
+
+              - script: |
+                  if [[ -f package-lock.json || -f npm-shrinkwrap.json ]]; then
+                    npm ci
+                  else
+                    npm install
+                  fi
+                displayName: 'Install dependencies'
+
+              - task: replacetokens@6
+                displayName: 'Substitute tokens in configuration.${env}.yaml'
+                inputs:
+                  sources: 'configuration.${env}.yaml'
+                  tokenPattern: 'custom'
+                  tokenPrefix: '{#['
+                  tokenSuffix: ']#}'
+                  missingVarAction: 'keep'
+
+              - script: |
+                  if grep -q '{#\\[' configuration.${env}.yaml; then
+                    echo "Unresolved tokens remain in configuration.${env}.yaml"
+                    grep -o '{#\\[[^]]*\\]#}' configuration.${env}.yaml | sort -u
+                    exit 1
+                  fi
+                displayName: 'Validate token substitution (${env})'
+
+              - task: AzureCLI@2
+                displayName: 'Publish to ${env} (incremental - last commit only)'
+                condition: ne('\${{ parameters.COMMIT_ID_CHOICE }}', 'publish-all-artifacts-in-repo')
+                inputs:
+                  azureSubscription: 'AZURE_SERVICE_CONNECTION_${envUpper}'
+                  scriptType: 'bash'
+                  scriptLocation: 'inlineScript'
+                  inlineScript: |
+                    npx apiops publish \\
+                      --resource-group $(APIM_RESOURCE_GROUP_${envUpper}) \\
+                      --service-name $(APIM_SERVICE_NAME_${envUpper}) \\
+                      --source ${config.artifactDir} \\
+                      --overrides configuration.${env}.yaml \\
+                      --commit-id $(Build.SourceVersion) \\
+                      --subscription-id $(AZURE_SUBSCRIPTION_ID)
+
+              - task: AzureCLI@2
+                displayName: 'Publish to ${env} (all artifacts)'
+                condition: eq('\${{ parameters.COMMIT_ID_CHOICE }}', 'publish-all-artifacts-in-repo')
+                inputs:
+                  azureSubscription: 'AZURE_SERVICE_CONNECTION_${envUpper}'
+                  scriptType: 'bash'
+                  scriptLocation: 'inlineScript'
+                  inlineScript: |
+                    npx apiops publish \\
+                      --resource-group $(APIM_RESOURCE_GROUP_${envUpper}) \\
+                      --service-name $(APIM_SERVICE_NAME_${envUpper}) \\
+                      --source ${config.artifactDir} \\
+                      --overrides configuration.${env}.yaml \\
+                      --subscription-id $(AZURE_SUBSCRIPTION_ID)
 `;
     }).join('\n');
-    return `# Azure DevOps Pipeline: Run APIM Publisher
-
-trigger:
-  branches:
-    include:
-      - main
-  paths:
-    include:
-      - '${config.artifactDir}/**'
-      - 'configuration.*.yaml'
-
-pr: none
-
-parameters:
-  - name: COMMIT_ID_CHOICE
-    type: string
-    displayName: 'Choose "publish-all-artifacts-in-repo" only when you want to force republishing all artifacts (e.g. after build failure). Otherwise stick with the default behavior of "publish-artifacts-in-last-commit"'
-    default: 'publish-artifacts-in-last-commit'
-    values:
-      - 'publish-artifacts-in-last-commit'
-      - 'publish-all-artifacts-in-repo'
-  - name: ENVIRONMENT
-    type: string
-    displayName: 'Choose which environment to publish to'
-    default: '${defaultEnvironment}'
-    values:
-${envValues}
-
-stages:
-${stages}
+    return `# Azure DevOps Pipeline: Run APIM Publisher
+
+trigger:
+  branches:
+    include:
+      - main
+  paths:
+    include:
+      - '${config.artifactDir}/**'
+      - 'configuration.*.yaml'
+
+pr: none
+
+parameters:
+  - name: COMMIT_ID_CHOICE
+    type: string
+    displayName: 'Choose "publish-all-artifacts-in-repo" only when you want to force republishing all artifacts (e.g. after build failure). Otherwise stick with the default behavior of "publish-artifacts-in-last-commit"'
+    default: 'publish-artifacts-in-last-commit'
+    values:
+      - 'publish-artifacts-in-last-commit'
+      - 'publish-all-artifacts-in-repo'
+  - name: ENVIRONMENT
+    type: string
+    displayName: 'Choose which environment to publish to'
+    default: '${defaultEnvironment}'
+    values:
+${envValues}
+
+stages:
+${stages}
 `;
 }
 //# sourceMappingURL=publish-pipeline.js.map

package/dist/templates/configs/filter-config.d.ts

@@ -1,5 +1,5 @@
 /**
- * T047: Sample filter configuration template
+ * Sample filter configuration template
  * Generates a sample configuration.extractor.yaml file
  */
 export declare function generateFilterConfig(): string;

package/dist/templates/configs/filter-config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"filter-config.d.ts","sourceRoot":"","sources":["../../../src/templates/configs/filter-config.ts"],"names":[],"mappings":"AAEA;;;GAGG;AAEH,wBAAgB,oBAAoB,IAAI,MAAM,CA8G7C"}
+{"version":3,"file":"filter-config.d.ts","sourceRoot":"","sources":["../../../src/templates/configs/filter-config.ts"],"names":[],"mappings":"AAEA;;;GAGG;AAEH,wBAAgB,oBAAoB,IAAI,MAAM,CAuH7C"}

package/dist/templates/configs/filter-config.js

@@ -1,118 +1,127 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 /**
- * T047: Sample filter configuration template
+ * Sample filter configuration template
  * Generates a sample configuration.extractor.yaml file
  */
 export function generateFilterConfig() {
-    return `# APIM Extract Filter Configuration
-# Customize this file to control which resources are extracted
-
-# Extract only specific APIs by name
-# apis:
-#   - echo-api
-#   - petstore-api
-
-# Advanced: Filter API sub-resources (operations, diagnostics, schemas, releases)
-# apis:
-#   - echo-api                        # Include all sub-resources
-#   - petstore-api:                   # Control sub-resources
-#       operations:
-#         - get-pets
-#         - create-pet
-#       diagnostics:
-#         - applicationinsights
-#       schemas: []                   # Exclude all schemas
-#       releases:
-#         - v1
-
-# Extract only specific products
-# products:
-#   - starter
-#   - unlimited
-
-# Extract only specific backends
-# backends:
-#   - backend-api
-#   - legacy-backend
-
-# Extract only specific named values
-# namedValues:
-#   - api-key
-#   - connection-string
-
-# Extract only specific loggers
-# loggers:
-#   - appinsights-logger
-
-# Extract only specific diagnostics
-# diagnostics:
-#   - applicationinsights
-
-# Extract only specific tags
-# tags:
-#   - production
-#   - external
-
-# Extract only specific policy fragments
-# policyFragments:
-#   - rate-limit-fragment
-#   - cors-fragment
-
-# Extract only specific gateways
-# gateways:
-#   - default
-#   - internal-gateway
-
-# Extract only specific version sets
-# versionSets:
-#   - payments-v1
-
-# Extract only specific groups
-# groups:
-#   - administrators
-
-# Extract only specific subscriptions
-# subscriptions:
-#   - starter-subscription
-
-# Extract only specific schemas
-# schemas:
-#   - pet-schema
-
-# Filter service-level policies
-# policies:
-#   - policy
-
-# Extract only specific policy restrictions
-# policyRestrictions:
-#   - global-policy-restriction
-
-# Extract only specific documentations
-# documentations:
-#   - getting-started
-
-# Extract only specific workspaces
-# workspaces:
-#   - dev-workspace
-
-# Advanced: Filter workspace sub-resources
-# workspaces:
-#   - team-workspace:
-#       apis:
-#         - team-api-1
-#         - team-api-2
-#       backends:
-#         - team-backend
-#       namedValues:
-#         - team-api-key
-
-# Filter behavior:
-# - Leave a section commented out to include ALL resources of that type
-# - Set a section to an empty array ([]) to exclude ALL resources of that type
-#   Example:
-#   gateways: []
-#   subscriptions: []
+    return `# APIM Extract Filter Configuration
+# Customize this file to control which resources are extracted
+# For full format details and examples, see:
+# https://github.com/Azure/apiops-cli/blob/main/docs/guides/filtering-resources.md
+
+# Extract only specific APIs by name (or wildcard pattern)
+# apis:
+#   - echo-api
+#   - petstore-api
+#   - 'prod-*'                       # Wildcard: all APIs starting with prod-
+#   - '*-internal-*'                 # Wildcard: all APIs containing -internal-
+
+# Advanced: Filter API sub-resources (operations, diagnostics, schemas, releases)
+# apis:
+#   - echo-api                        # Include all sub-resources
+#   - petstore-api:                   # Control sub-resources
+#       operations:
+#         - get-pets
+#         - create-pet
+#         - 'list-*'                  # Wildcard: all operations starting with list-
+#       diagnostics:
+#         - applicationinsights
+#       schemas: []                   # Exclude all schemas
+#       releases:
+#         - v1
+
+# Extract only specific products
+# products:
+#   - starter
+#   - unlimited
+
+# Extract only specific backends
+# backends:
+#   - backend-api
+#   - legacy-backend
+
+# Extract only specific named values
+# namedValues:
+#   - api-key
+#   - connection-string
+
+# Extract only specific loggers
+# loggers:
+#   - appinsights-logger
+
+# Extract only specific diagnostics
+# diagnostics:
+#   - applicationinsights
+
+# Extract only specific tags
+# tags:
+#   - production
+#   - external
+
+# Extract only specific policy fragments
+# policyFragments:
+#   - rate-limit-fragment
+#   - cors-fragment
+
+# Extract only specific gateways
+# gateways:
+#   - default
+#   - internal-gateway
+
+# Extract only specific version sets
+# versionSets:
+#   - payments-v1
+
+# Extract only specific groups
+# groups:
+#   - administrators
+
+# Extract only specific subscriptions
+# subscriptions:
+#   - starter-subscription
+
+# Extract only specific schemas
+# schemas:
+#   - pet-schema
+
+# Filter service-level policies
+# policies:
+#   - policy
+
+# Extract only specific policy restrictions
+# policyRestrictions:
+#   - global-policy-restriction
+
+# Extract only specific documentations
+# documentations:
+#   - getting-started
+
+# Extract only specific workspaces
+# workspaces:
+#   - dev-workspace
+
+# Advanced: Filter workspace sub-resources
+# workspaces:
+#   - team-workspace:
+#       apis:
+#         - team-api-1
+#         - team-api-2
+#       backends:
+#         - team-backend
+#       namedValues:
+#         - team-api-key
+
+# Filter behavior:
+# - Leave a section commented out to include ALL resources of that type
+# - Set a section to an empty array ([]) to exclude ALL resources of that type
+#   Example:
+#   gateways: []
+#   subscriptions: []
+# - Use * to match any characters: prod-* matches prod-api, prod-users
+# - Use ? to match a single character: api-v? matches api-v1, api-v2
+# - Exact names and wildcard patterns can be mixed in the same list
+# - All matching is case-insensitive
 `;
 }
 //# sourceMappingURL=filter-config.js.map

package/dist/templates/configs/filter-config.js.map

@@ -1 +1 @@
-{"version":3,"file":"filter-config.js","sourceRoot":"","sources":["../../../src/templates/configs/filter-config.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAClC;;;GAGG;AAEH,MAAM,UAAU,oBAAoB;IAClC,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4GR,CAAC;AACF,CAAC"}
+{"version":3,"file":"filter-config.js","sourceRoot":"","sources":["../../../src/templates/configs/filter-config.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAClC;;;GAGG;AAEH,MAAM,UAAU,oBAAoB;IAClC,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqHR,CAAC;AACF,CAAC"}

package/dist/templates/configs/override-config.d.ts

@@ -1,5 +1,5 @@
 /**
- * T047: Sample override configuration template per environment
+ * Sample override configuration template per environment
  * Generates environment-specific configuration.{env}.yaml files
  */
 export declare function generateOverrideConfig(environment: string): string;

package/dist/templates/configs/override-config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"override-config.d.ts","sourceRoot":"","sources":["../../../src/templates/configs/override-config.ts"],"names":[],"mappings":"AAEA;;;GAGG;AAEH,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CA4FlE"}
+{"version":3,"file":"override-config.d.ts","sourceRoot":"","sources":["../../../src/templates/configs/override-config.ts"],"names":[],"mappings":"AAEA;;;GAGG;AAEH,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CA6FlE"}