@typespec/http 1.0.0-rc.2-dev.5 → 1.0.0-rc.2-dev.7

package/dist/src/tsp-index.js.map

@@ -1 +1 @@
-{"version":3,"file":"tsp-index.js","sourceRoot":"","sources":["../../src/tsp-index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,EACL,WAAW,EACX,SAAS,EACT,OAAO,EACP,OAAO,EACP,IAAI,EACJ,KAAK,EACL,OAAO,EACP,cAAc,EACd,MAAM,EACN,KAAK,EACL,KAAK,EACL,IAAI,EACJ,MAAM,EACN,MAAM,EACN,OAAO,EACP,YAAY,EACZ,WAAW,EACX,QAAQ,GACT,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,SAAS,EACT,SAAS,EACT,qCAAqC,EACrC,UAAU,GACX,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,gBAAgB;AAChB,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,eAAe,EAAE;QACf,IAAI,EAAE,KAAK;QACX,UAAU,EAAE,WAAW;QACvB,QAAQ,EAAE,SAAS;QACnB,MAAM,EAAE,OAAO;QACf,MAAM,EAAE,OAAO;QACf,GAAG,EAAE,IAAI;QACT,MAAM,EAAE,OAAO;QACf,IAAI,EAAE,KAAK;QACX,aAAa,EAAE,cAAc;QAC7B,KAAK,EAAE,MAAM;QACb,IAAI,EAAE,KAAK;QACX,IAAI,EAAE,KAAK;QACX,GAAG,EAAE,IAAI;QACT,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,OAAO;QACf,WAAW,EAAE,YAAY;QACzB,UAAU,EAAE,WAAW;QACvB,OAAO,EAAE,QAAQ;KACe;IAClC,uBAAuB,EAAE;QACvB,QAAQ,EAAE,SAAS;QACnB,QAAQ,EAAE,SAAS;QACnB,SAAS,EAAE,UAAU;QACrB,oCAAoC,EAAE,qCAAqC;KACpC;CAC1C,CAAC"}
+{"version":3,"file":"tsp-index.js","sourceRoot":"","sources":["../../src/tsp-index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,EACL,WAAW,EACX,SAAS,EACT,OAAO,EACP,OAAO,EACP,IAAI,EACJ,KAAK,EACL,OAAO,EACP,cAAc,EACd,MAAM,EACN,KAAK,EACL,KAAK,EACL,IAAI,EACJ,MAAM,EACN,MAAM,EACN,OAAO,EACP,YAAY,EACZ,WAAW,EACX,QAAQ,GACT,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAC3F,OAAO,EACL,SAAS,EACT,SAAS,EACT,qCAAqC,EACrC,UAAU,GACX,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,gBAAgB;AAChB,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,eAAe,EAAE;QACf,IAAI,EAAE,KAAK;QACX,UAAU,EAAE,WAAW;QACvB,QAAQ,EAAE,SAAS;QACnB,MAAM,EAAE,OAAO;QACf,MAAM,EAAE,OAAO;QACf,GAAG,EAAE,IAAI;QACT,MAAM,EAAE,OAAO;QACf,IAAI,EAAE,KAAK;QACX,aAAa,EAAE,cAAc;QAC7B,KAAK,EAAE,MAAM;QACb,IAAI,EAAE,KAAK;QACX,IAAI,EAAE,KAAK;QACX,GAAG,EAAE,IAAI;QACT,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,OAAO;QACf,WAAW,EAAE,YAAY;QACzB,UAAU,EAAE,WAAW;QACvB,OAAO,EAAE,QAAQ;KACe;IAClC,uBAAuB,EAAE;QACvB,QAAQ,EAAE,SAAS;QACnB,QAAQ,EAAE,SAAS;QACnB,SAAS,EAAE,UAAU;QACrB,oCAAoC,EAAE,qCAAqC;QAC3E,eAAe,EAAE,gBAAgB;QACjC,eAAe,EAAE,gBAAgB;QACjC,kBAAkB,EAAE,mBAAmB;KACA;CAC1C,CAAC"}

package/lib/main.tsp

@@ -271,3 +271,93 @@ model Link {
 }
 
 scalar LinkHeader<T extends Record<url> | Link[]> extends string;
+
+/**
+ * Create a MergePatch Request body for updating the given resource Model.
+ * The MergePatch request created by this template provides a TypeSpec description of a
+ * JSON MergePatch request that can successfully update the given resource.
+ * The transformation follows the definition of JSON MergePatch requests in
+ * rfc 7396: https://www.rfc-editor.org/rfc/rfc7396,
+ * applying the merge-patch transform recursively to keyed types in the resource Model.
+ *
+ * Using this template in a PATCH request body overrides the `implicitOptionality`
+ * setting for PATCH operations and sets `application/merge-patch+json` as the request
+ * content-type.
+ *
+ * @template T The type of the resource to create a MergePatch update request body for.
+ * @template NameTemplate A StringTemplate used to name any models created by applying
+ * the merge-patch transform to the resource. The default name template is `{name}MergePatchUpdate`,
+ * for example, the merge patch transform of model `Widget` is named `WidgetMergePatchUpdate`.
+ *
+ * @example
+ * ```tsp
+ * // An operation updating a 'Widget' using merge-patch
+ * @patch op update(@body request: MergePatchUpdate<Widget>): Widget;
+ * ```
+ *
+ * @example
+ * ```tsp
+ * // An operation updating a 'Widget' using merge-patch
+ * @patch op update(@bodyRoot request: MergePatchUpdate<Widget>): Widget;
+ * ```
+ *
+ * @example
+ * ```tsp
+ * // An operation updating a 'Widget' using merge-patch
+ * @patch op update(...MergePatchUpdate<Widget>): Widget;
+ * ```
+ */
+@friendlyName(NameTemplate, T)
+@mediaTypeHint("application/merge-patch+json")
+@applyMergePatch(T, NameTemplate, #{ visibilityMode: Private.MergePatchVisibilityMode.Update })
+model MergePatchUpdate<
+  T extends Reflection.Model,
+  NameTemplate extends valueof string = "{name}MergePatchUpdate"
+> {}
+
+/**
+ * Create a MergePatch Request body for creating or updating the given resource Model.
+ * The MergePatch request created by this template provides a TypeSpec description of a
+ * JSON MergePatch request that can successfully create or update the given resource.
+ * The transformation follows the definition of JSON MergePatch requests in
+ * rfc 7396: https://www.rfc-editor.org/rfc/rfc7396,
+ * applying the merge-patch transform recursively to keyed types in the resource Model.
+ *
+ * Using this template in a PATCH request body overrides the `implicitOptionality`
+ * setting for PATCH operations and sets `application/merge-patch+json` as the request
+ * content-type.
+ *
+ * @template T The type of the resource to create a MergePatch update request body for.
+ * @template NameTemplate A StringTemplate used to name any models created by applying
+ * the merge-patch transform to the resource. The default name template is `{name}MergePatchCreateOrUpdate`,
+ * for example, the merge patch transform of model `Widget` is named `WidgetMergePatchCreateOrUpdate`.
+ *
+ * @example
+ * ```tsp
+ * // An operation updating a 'Widget' using merge-patch
+ * @patch op update(@body request: MergePatchCreateOrUpdate<Widget>): Widget;
+ * ```
+ *
+ * @example
+ * ```tsp
+ * // An operation updating a 'Widget' using merge-patch
+ * @patch op update(@bodyRoot request: MergePatchCreateOrUpdate<Widget>): Widget;
+ * ```
+ *
+ * @example
+ * ```tsp
+ * // An operation updating a 'Widget' using merge-patch
+ * @patch op update(...MergePatchCreateOrUpdate<Widget>): Widget;
+ * ```
+ */
+@friendlyName(NameTemplate, T)
+@mediaTypeHint("application/merge-patch+json")
+@applyMergePatch(
+  T,
+  NameTemplate,
+  #{ visibilityMode: Private.MergePatchVisibilityMode.CreateOrUpdate }
+)
+model MergePatchCreateOrUpdate<
+  T extends Reflection.Model,
+  NameTemplate extends valueof string = "{name}MergePatchCreateOrUpdate"
+> {}

package/lib/private.decorators.tsp

@@ -16,3 +16,51 @@ extern dec httpPart(
  * @param value If true, inapplicable metadata will be included in the payload.
  */
 extern dec includeInapplicableMetadataInPayload(target: unknown, value: valueof boolean);
+
+/**
+ * The visibility mode for the merge patch transform.
+ */
+enum MergePatchVisibilityMode {
+  /**
+   * The Update mode. This is used when a resource can be updated but must already exist.
+   */
+  Update,
+
+  /**
+   * The Create or Update mode. This is used when a resource can be created OR updated in a single operation.
+   */
+  CreateOrUpdate,
+}
+
+/**
+ * Options for the `@applyMergePatch` decorator.
+ */
+model ApplyMergePatchOptions {
+  /**
+   * The visibility mode to use.
+   */
+  visibilityMode: MergePatchVisibilityMode;
+}
+
+/**
+ * Performs the canonical merge-patch transformation on the given model and injects its
+ * transformed properties into the target.
+ */
+extern dec applyMergePatch(
+  target: Reflection.Model,
+  source: Reflection.Model,
+  nameTemplate: valueof string,
+  options: valueof ApplyMergePatchOptions
+);
+
+/**
+ * Marks a model that was generated by applying the MergePatch
+ * transform and links to its source model
+ */
+extern dec mergePatchModel(target: Reflection.Model, source: Reflection.Model);
+
+/**
+ * Links a modelProperty mutated as part of a mergePatch transform to
+ * its source property;
+ */
+extern dec mergePatchProperty(target: Reflection.ModelProperty, source: Reflection.ModelProperty);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/http",
-  "version": "1.0.0-rc.2-dev.5",
+  "version": "1.0.0-rc.2-dev.7",
   "author": "Microsoft Corporation",
   "description": "TypeSpec HTTP protocol binding",
   "homepage": "https://github.com/microsoft/typespec",
@@ -42,6 +42,9 @@
     "./experimental/typekit": {
       "types": "./dist/src/experimental/typekit/index.d.ts",
       "default": "./dist/src/experimental/typekit/index.js"
+    },
+    "./experimental/merge-patch": {
+      "import": "./dist/src/experimental/merge-patch/index.js"
     }
   },
   "engines": {