|
| 1 | +// Copyright (c) Microsoft Corporation. |
| 2 | +// Licensed under the MIT license. |
| 3 | +/** |
| 4 | + * Workspace link response helpers. |
| 5 | + * |
| 6 | + * In workspace scope, association resources (ProductApi, ProductGroup, ApiTag, |
| 7 | + * ProductTag) use "link" endpoints that return objects shaped like: |
| 8 | + * { name: "opaqueLinkId", properties: { apiId: "/subscriptions/.../apis/myApi" } } |
| 9 | + * |
| 10 | + * This module provides helpers to extract the actual resource name from |
| 11 | + * these link responses and to build link payloads for publishing. |
| 12 | + */ |
| 13 | + |
| 14 | +import { ApimServiceContext } from '../models/types.js'; |
| 15 | + |
| 16 | +/** |
| 17 | + * Extracts the resource name from a workspace link response item. |
| 18 | + * |
| 19 | + * Link responses store the associated resource's full ARM ID in a property |
| 20 | + * (e.g. `properties.apiId`). This function extracts the last path segment |
| 21 | + * (the resource name) from that ARM ID. |
| 22 | + * |
| 23 | + * @param json - Raw link response item from LIST |
| 24 | + * @param linkIdProperty - Property name containing the ARM ID (e.g. 'apiId', 'groupId') |
| 25 | + * @returns The extracted resource name, or undefined if not found |
| 26 | + */ |
| 27 | +export function extractNameFromLink( |
| 28 | + json: Record<string, unknown>, |
| 29 | + linkIdProperty: string |
| 30 | +): string | undefined { |
| 31 | + const properties = json.properties as Record<string, unknown> | undefined; |
| 32 | + if (!properties) { |
| 33 | + return undefined; |
| 34 | + } |
| 35 | + |
| 36 | + const armId = properties[linkIdProperty]; |
| 37 | + if (typeof armId !== 'string' || armId.length === 0) { |
| 38 | + return undefined; |
| 39 | + } |
| 40 | + |
| 41 | + // ARM resource IDs look like: /subscriptions/.../apis/myApiName |
| 42 | + // Extract the last segment as the resource name |
| 43 | + const segments = armId.split('/'); |
| 44 | + const lastSegment = segments[segments.length - 1]; |
| 45 | + return lastSegment && lastSegment.length > 0 |
| 46 | + ? decodeURIComponent(lastSegment) |
| 47 | + : undefined; |
| 48 | +} |
| 49 | + |
| 50 | +/** |
| 51 | + * Builds the full ARM resource ID for a workspace-scoped resource. |
| 52 | + * Used when creating link resources that reference another resource via its ARM ID. |
| 53 | + * |
| 54 | + * @param context - APIM service context (with workspace baseUrl) |
| 55 | + * @param resourcePath - The ARM path segment (e.g. 'apis/myApi' or 'groups/myGroup') |
| 56 | + * @returns Full ARM resource ID |
| 57 | + */ |
| 58 | +export function buildWorkspaceResourceId( |
| 59 | + context: ApimServiceContext, |
| 60 | + resourcePath: string |
| 61 | +): string { |
| 62 | + // context.baseUrl for workspace scope is: |
| 63 | + // https://management.azure.com/subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.ApiManagement/service/{svc}/workspaces/{ws} |
| 64 | + // We need to return: |
| 65 | + // /subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.ApiManagement/service/{svc}/workspaces/{ws}/{resourcePath} |
| 66 | + const url = new URL(context.baseUrl); |
| 67 | + return `${url.pathname}/${resourcePath}`; |
| 68 | +} |
| 69 | + |
| 70 | +/** |
| 71 | + * Checks whether a service context is workspace-scoped. |
| 72 | + * Workspace-scoped contexts have `/workspaces/{name}` appended after the |
| 73 | + * APIM service segment in their base URL. We match the specific ARM path |
| 74 | + * structure rather than a naive substring check, so an API or resource |
| 75 | + * named "workspaces" won't cause a false positive. |
| 76 | + */ |
| 77 | +const WORKSPACE_SCOPE_PATTERN = /\/Microsoft\.ApiManagement\/service\/[^/]+\/workspaces\/[^/]+/i; |
| 78 | + |
| 79 | +export function isWorkspaceScope(context: ApimServiceContext): boolean { |
| 80 | + return WORKSPACE_SCOPE_PATTERN.test(context.baseUrl); |
| 81 | +} |
| 82 | + |
| 83 | +/** |
| 84 | + * Builds the PUT payload for creating a workspace link resource. |
| 85 | + * |
| 86 | + * @param context - Workspace-scoped APIM context |
| 87 | + * @param linkIdProperty - Property name for the ARM ID (e.g. 'apiId', 'groupId') |
| 88 | + * @param resourceType - The ARM resource type segment (e.g. 'apis', 'groups', 'products') |
| 89 | + * @param resourceName - The resource name to link to |
| 90 | + * @returns PUT payload for the link resource |
| 91 | + */ |
| 92 | +export function buildLinkPayload( |
| 93 | + context: ApimServiceContext, |
| 94 | + linkIdProperty: string, |
| 95 | + resourceType: string, |
| 96 | + resourceName: string |
| 97 | +): Record<string, unknown> { |
| 98 | + const resourceId = buildWorkspaceResourceId( |
| 99 | + context, |
| 100 | + `${resourceType}/${encodeURIComponent(resourceName)}` |
| 101 | + ); |
| 102 | + |
| 103 | + return { |
| 104 | + properties: { |
| 105 | + [linkIdProperty]: resourceId, |
| 106 | + }, |
| 107 | + }; |
| 108 | +} |
0 commit comments