@typespec/rest 0.41.0

package/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation. All rights reserved.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

package/README.md

@@ -0,0 +1,134 @@
+# TypeSpec REST Library
+
+This package provides [TypeSpec](https://github.com/microsoft/TypeSpec) decorators, models, and interfaces to describe APIs using the [REST style](https://en.wikipedia.org/wiki/Representational_state_transfer). These building blocks make defining REST resources and operations based on standard patterns extremely simple.
+
+## Install
+
+In your TypeSpec project root
+
+```bash
+npm install @typespec/rest
+```
+
+## Usage
+
+```TypeSpec
+import "@typespec/rest";
+
+using TypeSpec.Rest;
+```
+
+See [Http and rest](https://microsoft.github.io/typespec/docs/standard-library/rest/).
+
+## Library Tour
+
+`@typespec/rest` library defines of the following artifacts:
+
+- [TypeSpec HTTP/Rest Library](#typespec-httprest-library)
+  - [Install](#install)
+  - [Usage](#usage)
+  - [Library Tour](#library-tour)
+  - [Models](#models)
+  - [Decorators](#decorators)
+  - [Interfaces](#interfaces)
+  - [See also](#see-also)
+
+## Models
+
+| Model                                      | Notes                                                                                                       |
+| ------------------------------------------ | ----------------------------------------------------------------------------------------------------------- |
+| KeysOf<T>                               | Dynamically gathers keys of the model type T.                                                               |
+| Page<T>                                 | A model defines page of T which includes an array of T and optional next link.                              |
+| ParentKeysOf<T>                         | Dynamically gathers parent keys of the model type T, which are referenced with `@parentResource` decorator. |
+| ResourceError                              | The default error response for resource operations that includes <br> `code: int32` and `message string`.   |
+| ResourceParameters&lt;TResource>           | Represents operation parameters for resource TResource. Default to KeysOf&lt;T>.                            |
+| ResourceCollectionParameters&lt;TResource> | Represents collection operation parameters for resource TResource. Default to ParentKeysOf&lt;T>            |
+| ResourceCreatedResponse&lt;T>              | Resource create operation completed successfully.                                                           |
+| ResourceDeletedResponse                    | Resource deleted successfully.                                                                              |
+
+## Decorators
+
+The `@typespec/rest` library defines the following decorators in `TypeSpec.Rest` namespace:
+
+| Declarator                | Scope                                                 | Syntax                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| ------------------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| @discriminator            | models                                                | Syntax:<br> `@discriminator(kindString)` <br><br>Note:<br> `@discriminator` allows defining polymorphic models to be used by API as parameters and return types. In many strongly typed languages, they are expressed as inheritance.                                                                                                                                                                                                                        |
+| @resource                 | Model                                                 | Syntax:<br> `@resource(collectionName)` <br><br>Note:<br> This decorator is to used to mark a model as a resource type with a name for the type's collection.                                                                                                                                                                                                                                                                                                |
+| @readsResource            | operations                                            | Syntax:<br> `@readsResource(modelType)` <br><br>Note:<br> This decorator is to used to signal the operation that is the Read operation for a particular resource.                                                                                                                                                                                                                                                                                            |
+| @createsResource          | operations                                            | Syntax:<br> `@createsResource(modelType)` <br><br>Note:<br> This decorator is to used to signal the operation that is the Create operation for a particular resource.                                                                                                                                                                                                                                                                                        |
+| @createsOrUpdatesResource | operations                                            | Syntax:<br> `@createsOrUpdatesResource(modelType)` <br><br>Note:<br> This decorator is to used to signal the operation that is the CreatesOrUpdate operation for a particular resource.                                                                                                                                                                                                                                                                      |
+| @updatesResource          | operations                                            | Syntax:<br> `@updatesResource(modelType)` <br><br>Note:<br> This decorator is to used to signal the operation that is the Update operation for a particular resource.                                                                                                                                                                                                                                                                                        |
+| @deletesResource          | operations                                            | Syntax:<br> `@deletesResource(modelType)` <br><br>Note:<br> This decorator is to used to signal the operation that is the Delete operation for a particular resource.                                                                                                                                                                                                                                                                                        |
+| @listsResource            | operations                                            | Syntax:<br> `@listsResource(modelType)` <br><br>Note:<br> This decorator is to used to signal the operation that is the List operation for a particular resource.                                                                                                                                                                                                                                                                                            |
+| @parentResource           | models                                                | Syntax:<br> `@parentResource(parentModelTypeReference)` <br><br>Note:<br> `@parentResource` marks a model property with a reference to its parent resource type. The first argument should be a reference to a model type which will be treated as the parent type of the target model type. This will cause the `@key` properties of all parent types of the target type to show up in operations of the `Resource*<T>` interfaces defined in this library. |
+| @segment                  | model properties, operation parameters                | Syntax:<br> `@segment(segmentString)` <br><br>Note:<br>`@segment` defines the preceding path segment for a `@path` parameter in auto-generated routes. The first argument should be a string that will be inserted into the operation route before the path parameter's name field. For example: <br> `op getUser(@path @segment("users") userId: string): User` <br> will produce the route `/users/{userId}`.                                              |
+| @segmentOf                | models                                                | Syntax:<br> `@segment(segmentString)` <br><br>Note:<br>`@segmentOf` returns the URL segment of a given model if it has `@segment` and `@key` decorator.                                                                                                                                                                                                                                                                                                      |
+| @segmentSeparator         | model properties, operation parameters, or operations | Syntax:<br> `@segmentSeparator(separatorString)` <br><br>Note:<br> `@segmentSeparator` defines the separator string that is inserted between the target's `@segment` and the preceding route path in auto-generated routes. <br> The first argument should be a string that will be inserted into the operation route before the target's `@segment` value. Can be a string of any length. Defaults to `/`.                                                  |
+| @actionSeparator          | model properties, operation parameters, or operations | Syntax:<br> `@actionSeparator(separatorString)` <br><br>Note:<br> `@actionSeparator` defines the separator string that is inserted before the action name in auto-generated routes for actions.                                                                                                                                                                                                                                                              |
+| @autoRoute                | operations                                            | Syntax:<br> `@autoRoute()` <br><br>Note:<br>`@autoRoute` enables automatic route generation for an operation, namespace, or interface. <br> When applied to an operation, it automatically generates the operation's route based on path parameter metadata. When applied to a namespace or interface, it causes all operations under that scope to have auto-generated routes.                                                                              |
+
+## Interfaces
+
+These standard interfaces defines resource operations in basic building blocks that you can expose on the resources. You can use `extends` to compose the operations to meet the exact needs of your resource APIs.
+
+For example, for below `Widget` model
+
+```
+@resource("widgets")
+model Widget {
+  @key id: string;
+  name: string;
+}
+```
+
+- `Widget` resource supports full CRUDL operations.
+
+```TypeSpec
+interface WidgetService extends Resource.ResourceOperations<Widget, Error>;
+```
+
+- `Widget` resource supports only CRD operations.
+
+```TypeSpec
+interface WidgetService
+   extends Resource.ResourceRead<Widget, Error>,
+    Resource.ResourceCreate<Widget, Error>,
+    Resource.ResourceDelete<Widget, Error> {
+}
+```
+
+-
+
+| Interfaces                                                              | Notes                                                                                                                |
+| ----------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
+| ResourceRead&lt;TResource, TError>                                      | Resource GET operation                                                                                               |
+| ResourceCreateOrUpdate&lt;TResource, TError>                            | Resource PUT operation                                                                                               |
+| ResourceCreate&lt;TResource, TError>                                    | Resource POST operation                                                                                              |
+| ResourceUpdate&lt;TResource, TError>                                    | Resource PATCH operation                                                                                             |
+| ResourceDelete&lt;TResource, TError>                                    | Resource DEL operation                                                                                               |
+| ResourceList&lt;TResource, TError>                                      | Resource LIST operation which is a GET operation from a parent resource.                                             |
+| ResourceInstanceOperations&lt;TResource, TError>                        | Combines resource GET + PATCH + DEL operations                                                                       |
+| ResourceCollectionOperations&lt;TResource, TError>                      | Combines resource POST + LIST operations                                                                             |
+| ResourceOperations&lt;TResource, TError>                                | Combines resource instance and collection operations. Includes GET + PATCH + DEL + POST + LIST                       |
+| SingletonResourceRead&lt;TSingleton, TResource, TError>                 | Singleton resource GET operation.                                                                                    |
+| SingletonResourceUpdate&lt;TSingleton, TResource, TError>               | Singleton resource PATCH operation.                                                                                  |
+| SingletonResourceOperations&lt;TSingleton, TResource, TError>           | Combines resource GET + PATCH operations                                                                             |
+| ExtensionResourceRead&lt;TExtension, TResource, TError>                 | Extension resource GET operation.                                                                                    |
+| ExtensionResourceCreateOrUpdate&lt;TExtension, TResource, TError>       | Extension resource PUT operation                                                                                     |
+| ExtensionResourceCreate&lt;TExtension, TResource, TError>               | Extension resource POST operation                                                                                    |
+| ExtensionResourceUpdate&lt;TExtension, TResource, TError>               | Extension resource PATCH operation                                                                                   |
+| ExtensionResourceDelete&lt;TExtension, TResource, TError>               | Extension resource GET operation                                                                                     |
+| ExtensionResourceList&lt;TExtension, TResource, TError>                 | Extension resource LIST operation which is a GET operation from a parent resource.                                   |
+| ExtensionResourceInstanceOperations&lt;TExtension, TResource, TError>   | Combines extension resource GET + PATCH + DEL operations.                                                            |
+| ExtensionResourceCollectionOperations&lt;TExtension, TResource, TError> | Combines extension resource POST + LIST operations.                                                                  |
+| ExtensionResourceOperations&lt;TExtension, TResource, TError>           | Combines extension resource instance and collection operations. Includes GET + PATCH + DEL + POST + LIST operations. |
+
+## See also
+
+- [REST example](https://cadlplayground.z22.web.core.windows.net/?c=aW1wb3J0ICJAY2FkbC1sYW5nL3Jlc3QiOwoKQHNlcnZpY2VUaXRsZSgiV2lkZ2V0IFPGFSIpCm5hbWVzcGFjZSBEZW1vxxg7Cgp1c2luZyBDYWRsLkh0dHA7zBFSZXN0OwoKbW9kZWwgx1J7CiAgQGtleSBpZDogc3RyaW5nOwogIHdlaWdodDogaW50MzLEEWNvbG9yOiAicmVkIiB8ICJibHVlIjsKfQoKQGVycm9yx1ZFxAzFVWNvZGXLQG1lc3NhZ2XKZH0KCmludGVyZuQAxOYAjecAxiBleHRlbmRzIFJlc291cmNl5AC5xQlPcGVyYXRpb25zPMYyLMZxPsVyQOQA0EByb3V0ZSgiY3VzdG9tR2V0IikgyQwoKTrHa%2BQAgA%3D%3D):
+- [TypeSpec Getting Started](https://github.com/microsoft/typespec#getting-started)
+- [TypeSpec Website](https://microsoft.github.io/typespec)
+
+```
+
+```

package/dist/src/index.d.ts

@@ -0,0 +1,5 @@
+export declare const namespace = "TypeSpec.Rest";
+export * from "./resource.js";
+export * from "./rest.js";
+export * from "./validate.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS,kBAAkB,CAAC;AACzC,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,5 @@
+export const namespace = "TypeSpec.Rest";
+export * from "./resource.js";
+export * from "./rest.js";
+export * from "./validate.js";
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,SAAS,GAAG,eAAe,CAAC;AACzC,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC"}

package/dist/src/internal-decorators.d.ts

@@ -0,0 +1,5 @@
+import { DecoratorContext, Type } from "@typespec/compiler";
+export declare const namespace = "TypeSpec.Rest.Private";
+export declare function $validateHasKey(context: DecoratorContext, target: Type, value: Type): void;
+export declare function $validateIsError(context: DecoratorContext, target: Type, value: Type): void;
+//# sourceMappingURL=internal-decorators.d.ts.map

package/dist/src/internal-decorators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal-decorators.d.ts","sourceRoot":"","sources":["../../src/internal-decorators.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAEhB,IAAI,EAEL,MAAM,oBAAoB,CAAC;AAI5B,eAAO,MAAM,SAAS,0BAA0B,CAAC;AAIjD,wBAAgB,eAAe,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,QAgBnF;AAID,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,QAgBpF"}

package/dist/src/internal-decorators.js

@@ -0,0 +1,43 @@
+import { isErrorModel, validateDecoratorParamType, } from "@typespec/compiler";
+import { createStateSymbol, reportDiagnostic } from "./lib.js";
+import { getResourceTypeKey } from "./resource.js";
+export const namespace = "TypeSpec.Rest.Private";
+const validatedMissingKey = createStateSymbol("validatedMissing");
+// Workaround for the lack of template constraints https://github.com/microsoft/typespec/issues/377
+export function $validateHasKey(context, target, value) {
+    if (!validateDecoratorParamType(context.program, target, value, "Model")) {
+        return;
+    }
+    if (context.program.stateSet(validatedMissingKey).has(value)) {
+        return;
+    }
+    const resourceKey = getResourceTypeKey(context.program, value);
+    if (resourceKey === undefined) {
+        reportDiagnostic(context.program, {
+            code: "resource-missing-key",
+            format: { modelName: value.name },
+            target: value,
+        });
+        context.program.stateSet(validatedMissingKey).add(value);
+    }
+}
+const validatedErrorKey = createStateSymbol("validatedError");
+// Workaround for the lack of template constraints https://github.com/microsoft/typespec/issues/377
+export function $validateIsError(context, target, value) {
+    if (!validateDecoratorParamType(context.program, target, value, "Model")) {
+        return;
+    }
+    if (context.program.stateSet(validatedErrorKey).has(value)) {
+        return;
+    }
+    const isError = isErrorModel(context.program, value);
+    if (!isError) {
+        reportDiagnostic(context.program, {
+            code: "resource-missing-error",
+            format: { modelName: value.name },
+            target: value,
+        });
+        context.program.stateSet(validatedErrorKey).add(value);
+    }
+}
+//# sourceMappingURL=internal-decorators.js.map

package/dist/src/internal-decorators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal-decorators.js","sourceRoot":"","sources":["../../src/internal-decorators.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,YAAY,EAEZ,0BAA0B,GAC3B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAEnD,MAAM,CAAC,MAAM,SAAS,GAAG,uBAAuB,CAAC;AAEjD,MAAM,mBAAmB,GAAG,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;AAClE,mGAAmG;AACnG,MAAM,UAAU,eAAe,CAAC,OAAyB,EAAE,MAAY,EAAE,KAAW;IAClF,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE;QACxE,OAAO;KACR;IACD,IAAI,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;QAC5D,OAAO;KACR;IACD,MAAM,WAAW,GAAG,kBAAkB,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC/D,IAAI,WAAW,KAAK,SAAS,EAAE;QAC7B,gBAAgB,CAAC,OAAO,CAAC,OAAO,EAAE;YAChC,IAAI,EAAE,sBAAsB;YAC5B,MAAM,EAAE,EAAE,SAAS,EAAE,KAAK,CAAC,IAAI,EAAE;YACjC,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;QACH,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;KAC1D;AACH,CAAC;AAED,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;AAC9D,mGAAmG;AACnG,MAAM,UAAU,gBAAgB,CAAC,OAAyB,EAAE,MAAY,EAAE,KAAW;IACnF,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE;QACxE,OAAO;KACR;IACD,IAAI,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;QAC1D,OAAO;KACR;IACD,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACrD,IAAI,CAAC,OAAO,EAAE;QACZ,gBAAgB,CAAC,OAAO,CAAC,OAAO,EAAE;YAChC,IAAI,EAAE,wBAAwB;YAC9B,MAAM,EAAE,EAAE,SAAS,EAAE,KAAK,CAAC,IAAI,EAAE;YACjC,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;QACH,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;KACxD;AACH,CAAC"}

package/dist/src/lib.d.ts

@@ -0,0 +1,84 @@
+declare const restLib: import("@typespec/compiler").TypeSpecLibrary<{
+    "not-key-type": {
+        readonly default: "Cannot copy keys from a non-key type (KeysOf<T> or ParentKeysOf<T>)";
+    };
+    "resource-missing-key": {
+        readonly default: import("@typespec/compiler").CallableMessage<["modelName"]>;
+    };
+    "resource-missing-error": {
+        readonly default: import("@typespec/compiler").CallableMessage<["modelName"]>;
+    };
+    "duplicate-key": {
+        readonly default: import("@typespec/compiler").CallableMessage<["resourceName"]>;
+    };
+    "duplicate-parent-key": {
+        readonly default: import("@typespec/compiler").CallableMessage<["resourceName", "keyName"]>;
+    };
+}, Record<string, any>>;
+declare const reportDiagnostic: <C extends "not-key-type" | "resource-missing-key" | "resource-missing-error" | "duplicate-key" | "duplicate-parent-key", M extends keyof {
+    "not-key-type": {
+        readonly default: "Cannot copy keys from a non-key type (KeysOf<T> or ParentKeysOf<T>)";
+    };
+    "resource-missing-key": {
+        readonly default: import("@typespec/compiler").CallableMessage<["modelName"]>;
+    };
+    "resource-missing-error": {
+        readonly default: import("@typespec/compiler").CallableMessage<["modelName"]>;
+    };
+    "duplicate-key": {
+        readonly default: import("@typespec/compiler").CallableMessage<["resourceName"]>;
+    };
+    "duplicate-parent-key": {
+        readonly default: import("@typespec/compiler").CallableMessage<["resourceName", "keyName"]>;
+    };
+}[C]>(program: import("@typespec/compiler").Program, diag: import("@typespec/compiler").DiagnosticReport<{
+    "not-key-type": {
+        readonly default: "Cannot copy keys from a non-key type (KeysOf<T> or ParentKeysOf<T>)";
+    };
+    "resource-missing-key": {
+        readonly default: import("@typespec/compiler").CallableMessage<["modelName"]>;
+    };
+    "resource-missing-error": {
+        readonly default: import("@typespec/compiler").CallableMessage<["modelName"]>;
+    };
+    "duplicate-key": {
+        readonly default: import("@typespec/compiler").CallableMessage<["resourceName"]>;
+    };
+    "duplicate-parent-key": {
+        readonly default: import("@typespec/compiler").CallableMessage<["resourceName", "keyName"]>;
+    };
+}, C, M>) => void, createDiagnostic: <C extends "not-key-type" | "resource-missing-key" | "resource-missing-error" | "duplicate-key" | "duplicate-parent-key", M extends keyof {
+    "not-key-type": {
+        readonly default: "Cannot copy keys from a non-key type (KeysOf<T> or ParentKeysOf<T>)";
+    };
+    "resource-missing-key": {
+        readonly default: import("@typespec/compiler").CallableMessage<["modelName"]>;
+    };
+    "resource-missing-error": {
+        readonly default: import("@typespec/compiler").CallableMessage<["modelName"]>;
+    };
+    "duplicate-key": {
+        readonly default: import("@typespec/compiler").CallableMessage<["resourceName"]>;
+    };
+    "duplicate-parent-key": {
+        readonly default: import("@typespec/compiler").CallableMessage<["resourceName", "keyName"]>;
+    };
+}[C]>(diag: import("@typespec/compiler").DiagnosticReport<{
+    "not-key-type": {
+        readonly default: "Cannot copy keys from a non-key type (KeysOf<T> or ParentKeysOf<T>)";
+    };
+    "resource-missing-key": {
+        readonly default: import("@typespec/compiler").CallableMessage<["modelName"]>;
+    };
+    "resource-missing-error": {
+        readonly default: import("@typespec/compiler").CallableMessage<["modelName"]>;
+    };
+    "duplicate-key": {
+        readonly default: import("@typespec/compiler").CallableMessage<["resourceName"]>;
+    };
+    "duplicate-parent-key": {
+        readonly default: import("@typespec/compiler").CallableMessage<["resourceName", "keyName"]>;
+    };
+}, C, M>) => import("@typespec/compiler").Diagnostic, createStateSymbol: (name: string) => symbol;
+export { restLib, reportDiagnostic, createDiagnostic, createStateSymbol };
+//# sourceMappingURL=lib.d.ts.map

package/dist/src/lib.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lib.d.ts","sourceRoot":"","sources":["../../src/lib.ts"],"names":[],"mappings":"AAsCA,QAAA,MAAM,OAAO;;;;;;;;;;;;;;;;uBAAuC,CAAC;AACrD,QAAA,MAAQ,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAAE,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sDAAE,iBAAiB,0BAAY,CAAC;AAE1E,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,CAAC"}

package/dist/src/lib.js

@@ -0,0 +1,40 @@
+import { createTypeSpecLibrary, paramMessage } from "@typespec/compiler";
+const libDefinition = {
+    name: "@typespec/rest",
+    diagnostics: {
+        "not-key-type": {
+            severity: "error",
+            messages: {
+                default: "Cannot copy keys from a non-key type (KeysOf<T> or ParentKeysOf<T>)",
+            },
+        },
+        "resource-missing-key": {
+            severity: "error",
+            messages: {
+                default: paramMessage `Type '${"modelName"}' is used as a resource and therefore must have a key. Use @key to designate a property as the key.`,
+            },
+        },
+        "resource-missing-error": {
+            severity: "error",
+            messages: {
+                default: paramMessage `Type '${"modelName"}' is used as an error and therefore must have the @error decorator applied.`,
+            },
+        },
+        "duplicate-key": {
+            severity: "error",
+            messages: {
+                default: paramMessage `More than one key found on model type ${"resourceName"}`,
+            },
+        },
+        "duplicate-parent-key": {
+            severity: "error",
+            messages: {
+                default: paramMessage `Resource type '${"resourceName"}' has a key property named '${"keyName"}' which conflicts with the key name of a parent or child resource.`,
+            },
+        },
+    },
+};
+const restLib = createTypeSpecLibrary(libDefinition);
+const { reportDiagnostic, createDiagnostic, createStateSymbol } = restLib;
+export { restLib, reportDiagnostic, createDiagnostic, createStateSymbol };
+//# sourceMappingURL=lib.js.map

package/dist/src/lib.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lib.js","sourceRoot":"","sources":["../../src/lib.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEzE,MAAM,aAAa,GAAG;IACpB,IAAI,EAAE,gBAAgB;IACtB,WAAW,EAAE;QACX,cAAc,EAAE;YACd,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,qEAAqE;aAC/E;SACF;QACD,sBAAsB,EAAE;YACtB,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,SAAS,WAAW,qGAAqG;aAC/I;SACF;QACD,wBAAwB,EAAE;YACxB,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,SAAS,WAAW,6EAA6E;aACvH;SACF;QACD,eAAe,EAAE;YACf,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,yCAAyC,cAAc,EAAE;aAC/E;SACF;QACD,sBAAsB,EAAE;YACtB,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,kBAAkB,cAAc,+BAA+B,SAAS,oEAAoE;aAClK;SACF;KACF;CACO,CAAC;AAEX,MAAM,OAAO,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAAC;AACrD,MAAM,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC;AAE1E,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,CAAC"}

package/dist/src/resource.d.ts

@@ -0,0 +1,22 @@
+import { DecoratorContext, Model, ModelProperty, Program, Type } from "@typespec/compiler";
+export interface ResourceKey {
+    resourceType: Model;
+    keyProperty: ModelProperty;
+}
+export declare function setResourceTypeKey(program: Program, resourceType: Model, keyProperty: ModelProperty): void;
+export declare function getResourceTypeKey(program: Program, resourceType: Model): ResourceKey | undefined;
+export declare function $resourceTypeForKeyParam(context: DecoratorContext, entity: Type, resourceType: Type): void;
+export declare function getResourceTypeForKeyParam(program: Program, param: ModelProperty): Model | undefined;
+export declare function $copyResourceKeyParameters(context: DecoratorContext, entity: Type, filter?: string): void;
+export declare function getParentResource(program: Program, resourceType: Model): Model | undefined;
+/**
+ * `@parentResource` marks a model with a reference to its parent resource type
+ *
+ * The first argument should be a reference to a model type which will be treated as the parent
+ * type of the target model type.  This will cause the `@key` properties of all parent types of
+ * the target type to show up in operations of the `Resource*<T>` interfaces defined in this library.
+ *
+ * `@parentResource` can only be applied to models.
+ */
+export declare function $parentResource(context: DecoratorContext, entity: Type, parentType: Type): void;
+//# sourceMappingURL=resource.d.ts.map

package/dist/src/resource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["../../src/resource.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,gBAAgB,EAIhB,KAAK,EACL,aAAa,EACb,OAAO,EACP,IAAI,EAEL,MAAM,oBAAoB,CAAC;AAI5B,MAAM,WAAW,WAAW;IAC1B,YAAY,EAAE,KAAK,CAAC;IACpB,WAAW,EAAE,aAAa,CAAC;CAC5B;AAKD,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,OAAO,EAChB,YAAY,EAAE,KAAK,EACnB,WAAW,EAAE,aAAa,GACzB,IAAI,CAKN;AAED,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,GAAG,WAAW,GAAG,SAAS,CA+BjG;AAED,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,IAAI,EACZ,YAAY,EAAE,IAAI,QAOnB;AAED,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,OAAO,EAChB,KAAK,EAAE,aAAa,GACnB,KAAK,GAAG,SAAS,CAEnB;AA6CD,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,IAAI,EACZ,MAAM,CAAC,EAAE,MAAM,QAmChB;AAGD,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,GAAG,KAAK,GAAG,SAAS,CAE1F;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,QAOxF"}

package/dist/src/resource.js

@@ -0,0 +1,140 @@
+import { $visibility, getKeyName, isErrorType, isKey, validateDecoratorTarget, } from "@typespec/compiler";
+import { $path } from "@typespec/http";
+import { createStateSymbol, reportDiagnostic } from "./lib.js";
+const resourceKeysKey = createStateSymbol("resourceKeys");
+const resourceTypeForKeyParamKey = createStateSymbol("resourceTypeForKeyParam");
+export function setResourceTypeKey(program, resourceType, keyProperty) {
+    program.stateMap(resourceKeysKey).set(resourceType, {
+        resourceType,
+        keyProperty,
+    });
+}
+export function getResourceTypeKey(program, resourceType) {
+    // Look up the key first
+    let resourceKey = program.stateMap(resourceKeysKey).get(resourceType);
+    if (resourceKey) {
+        return resourceKey;
+    }
+    // Try to find it in the resource type
+    resourceType.properties.forEach((p) => {
+        if (isKey(program, p)) {
+            if (resourceKey) {
+                reportDiagnostic(program, {
+                    code: "duplicate-key",
+                    format: {
+                        resourceName: resourceType.name,
+                    },
+                    target: p,
+                });
+            }
+            else {
+                resourceKey = {
+                    resourceType,
+                    keyProperty: p,
+                };
+                // Cache the key for future queries
+                setResourceTypeKey(program, resourceType, resourceKey.keyProperty);
+            }
+        }
+    });
+    return resourceKey;
+}
+export function $resourceTypeForKeyParam(context, entity, resourceType) {
+    if (!validateDecoratorTarget(context, entity, "@resourceTypeForKeyParam", "ModelProperty")) {
+        return;
+    }
+    context.program.stateMap(resourceTypeForKeyParamKey).set(entity, resourceType);
+}
+export function getResourceTypeForKeyParam(program, param) {
+    return program.stateMap(resourceTypeForKeyParamKey).get(param);
+}
+function cloneKeyProperties(context, target, resourceType) {
+    const { program } = context;
+    // Add parent keys first
+    const parentType = getParentResource(program, resourceType);
+    if (parentType) {
+        cloneKeyProperties(context, target, parentType);
+    }
+    const resourceKey = getResourceTypeKey(program, resourceType);
+    if (resourceKey) {
+        const { keyProperty } = resourceKey;
+        const keyName = getKeyName(program, keyProperty);
+        const decorators = [
+            // Filter out the @visibility decorator because it might affect metadata
+            // filtering. NOTE: Check for name equality instead of function equality
+            // to deal with multiple copies of core being used.
+            ...keyProperty.decorators.filter((d) => d.decorator.name !== $visibility.name),
+            {
+                decorator: $path,
+                args: [],
+            },
+            {
+                decorator: $resourceTypeForKeyParam,
+                args: [{ node: target.node, value: resourceType }],
+            },
+        ];
+        // Clone the key property and ensure that an optional key property doesn't
+        // become an optional path parameter
+        const newProp = program.checker.cloneType(keyProperty, {
+            name: keyName,
+            decorators,
+            optional: false,
+            model: target,
+            sourceProperty: undefined,
+        });
+        // Add the key property to the target type
+        target.properties.set(keyName, newProp);
+    }
+}
+export function $copyResourceKeyParameters(context, entity, filter) {
+    if (!validateDecoratorTarget(context, entity, "@copyResourceKeyParameters", "Model")) {
+        return;
+    }
+    const reportNoKeyError = () => reportDiagnostic(context.program, {
+        code: "not-key-type",
+        target: entity,
+    });
+    const templateArguments = entity.templateArguments;
+    if (!templateArguments || templateArguments.length !== 1) {
+        return reportNoKeyError();
+    }
+    if (templateArguments[0].kind !== "Model") {
+        if (isErrorType(templateArguments[0])) {
+            return;
+        }
+        return reportNoKeyError();
+    }
+    const resourceType = templateArguments[0];
+    if (filter === "parent") {
+        // Only copy keys of the parent type if there is one
+        const parentType = getParentResource(context.program, resourceType);
+        if (parentType) {
+            cloneKeyProperties(context, entity, parentType);
+        }
+    }
+    else {
+        // Copy keys of the resource type and all parents
+        cloneKeyProperties(context, entity, resourceType);
+    }
+}
+const parentResourceTypesKey = createStateSymbol("parentResourceTypes");
+export function getParentResource(program, resourceType) {
+    return program.stateMap(parentResourceTypesKey).get(resourceType);
+}
+/**
+ * `@parentResource` marks a model with a reference to its parent resource type
+ *
+ * The first argument should be a reference to a model type which will be treated as the parent
+ * type of the target model type.  This will cause the `@key` properties of all parent types of
+ * the target type to show up in operations of the `Resource*<T>` interfaces defined in this library.
+ *
+ * `@parentResource` can only be applied to models.
+ */
+export function $parentResource(context, entity, parentType) {
+    if (!validateDecoratorTarget(context, parentType, "@parentResource", "Model")) {
+        return;
+    }
+    const { program } = context;
+    program.stateMap(parentResourceTypesKey).set(entity, parentType);
+}
+//# sourceMappingURL=resource.js.map

package/dist/src/resource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource.js","sourceRoot":"","sources":["../../src/resource.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EAEX,UAAU,EACV,WAAW,EACX,KAAK,EAKL,uBAAuB,GACxB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAO/D,MAAM,eAAe,GAAG,iBAAiB,CAAC,cAAc,CAAC,CAAC;AAC1D,MAAM,0BAA0B,GAAG,iBAAiB,CAAC,yBAAyB,CAAC,CAAC;AAEhF,MAAM,UAAU,kBAAkB,CAChC,OAAgB,EAChB,YAAmB,EACnB,WAA0B;IAE1B,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,YAAY,EAAE;QAClD,YAAY;QACZ,WAAW;KACZ,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,OAAgB,EAAE,YAAmB;IACtE,wBAAwB;IACxB,IAAI,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IACtE,IAAI,WAAW,EAAE;QACf,OAAO,WAAW,CAAC;KACpB;IAED,sCAAsC;IACtC,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAgB,EAAE,EAAE;QACnD,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE;YACrB,IAAI,WAAW,EAAE;gBACf,gBAAgB,CAAC,OAAO,EAAE;oBACxB,IAAI,EAAE,eAAe;oBACrB,MAAM,EAAE;wBACN,YAAY,EAAE,YAAY,CAAC,IAAI;qBAChC;oBACD,MAAM,EAAE,CAAC;iBACV,CAAC,CAAC;aACJ;iBAAM;gBACL,WAAW,GAAG;oBACZ,YAAY;oBACZ,WAAW,EAAE,CAAC;iBACf,CAAC;gBAEF,mCAAmC;gBACnC,kBAAkB,CAAC,OAAO,EAAE,YAAY,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC;aACpE;SACF;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,MAAM,UAAU,wBAAwB,CACtC,OAAyB,EACzB,MAAY,EACZ,YAAkB;IAElB,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,MAAM,EAAE,0BAA0B,EAAE,eAAe,CAAC,EAAE;QAC1F,OAAO;KACR;IAED,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,0BAA0B,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;AACjF,CAAC;AAED,MAAM,UAAU,0BAA0B,CACxC,OAAgB,EAChB,KAAoB;IAEpB,OAAO,OAAO,CAAC,QAAQ,CAAC,0BAA0B,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AACjE,CAAC;AAED,SAAS,kBAAkB,CAAC,OAAyB,EAAE,MAAa,EAAE,YAAmB;IACvF,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAC5B,wBAAwB;IACxB,MAAM,UAAU,GAAG,iBAAiB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAC5D,IAAI,UAAU,EAAE;QACd,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;KACjD;IAED,MAAM,WAAW,GAAG,kBAAkB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAC9D,IAAI,WAAW,EAAE;QACf,MAAM,EAAE,WAAW,EAAE,GAAG,WAAW,CAAC;QACpC,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QAEjD,MAAM,UAAU,GAAG;YACjB,wEAAwE;YACxE,wEAAwE;YACxE,mDAAmD;YACnD,GAAG,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,KAAK,WAAW,CAAC,IAAI,CAAC;YAC9E;gBACE,SAAS,EAAE,KAAK;gBAChB,IAAI,EAAE,EAAE;aACT;YACD;gBACE,SAAS,EAAE,wBAAwB;gBACnC,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;aACnD;SACF,CAAC;QAEF,0EAA0E;QAC1E,oCAAoC;QACpC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,WAAW,EAAE;YACrD,IAAI,EAAE,OAAO;YACb,UAAU;YACV,QAAQ,EAAE,KAAK;YACf,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,SAAS;SAC1B,CAAC,CAAC;QAEH,0CAA0C;QAC1C,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;KACzC;AACH,CAAC;AAED,MAAM,UAAU,0BAA0B,CACxC,OAAyB,EACzB,MAAY,EACZ,MAAe;IAEf,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,MAAM,EAAE,4BAA4B,EAAE,OAAO,CAAC,EAAE;QACpF,OAAO;KACR;IAED,MAAM,gBAAgB,GAAG,GAAG,EAAE,CAC5B,gBAAgB,CAAC,OAAO,CAAC,OAAO,EAAE;QAChC,IAAI,EAAE,cAAc;QACpB,MAAM,EAAE,MAAM;KACf,CAAC,CAAC;IACL,MAAM,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;IACnD,IAAI,CAAC,iBAAiB,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC,EAAE;QACxD,OAAO,gBAAgB,EAAE,CAAC;KAC3B;IAED,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,EAAE;QACzC,IAAI,WAAW,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,EAAE;YACrC,OAAO;SACR;QACD,OAAO,gBAAgB,EAAE,CAAC;KAC3B;IAED,MAAM,YAAY,GAAG,iBAAiB,CAAC,CAAC,CAAU,CAAC;IAEnD,IAAI,MAAM,KAAK,QAAQ,EAAE;QACvB,oDAAoD;QACpD,MAAM,UAAU,GAAG,iBAAiB,CAAC,OAAO,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACpE,IAAI,UAAU,EAAE;YACd,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;SACjD;KACF;SAAM;QACL,iDAAiD;QACjD,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;KACnD;AACH,CAAC;AAED,MAAM,sBAAsB,GAAG,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;AACxE,MAAM,UAAU,iBAAiB,CAAC,OAAgB,EAAE,YAAmB;IACrE,OAAO,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;AACpE,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAAC,OAAyB,EAAE,MAAY,EAAE,UAAgB;IACvF,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE;QAC7E,OAAO;KACR;IACD,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAE5B,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;AACnE,CAAC"}