@wix/auto_sdk_git-code-store_projects 1.0.0 → 1.0.2

package/build/internal/cjs/index.d.ts

@@ -6,10 +6,15 @@ declare function generateGitCodeStoreProjectDownloadUrl$1(httpClient: HttpClient
 interface GenerateGitCodeStoreProjectDownloadUrlSignature {
     /**
      * Generates a temporary URL to download all tracked files at one revision as a ZIP.
+     *
      * Includes hidden directories, binary files and materialized LFS objects; excludes Git history.
-     * Defaults to main. Supply the returned revision when committing uploaded code unless force is true.
+     * Defaults to main. Omit `revisionId` to download the current branch head.
+     * Supply the returned revision when committing uploaded code unless force is true.
+     * Supports at most 10,000 tracked files, 256 MiB expanded, and a 64 MiB ZIP.
+     * Rejects unsafe paths, submodules, special files, and dangling or escaping symlinks.
      * Requires an authenticated user with read access to the app or its companion site.
-     * @param - Managed project whose code will be downloaded.
+     * @param - ID of the existing AppManagedProject whose code will be downloaded.
+     * This identifies the managed project, not its site or a legacy v1 Code Store project.
      */
     (managedProjectId: string, options?: GenerateGitCodeStoreProjectDownloadUrlOptions): Promise<NonNullablePaths<GenerateGitCodeStoreProjectDownloadUrlResponse, `downloadUrl` | `revision.author.name` | `revision.author.email` | `branchName`, 2> & {
         __applicationErrorsType?: GenerateGitCodeStoreProjectDownloadUrlApplicationErrors;
@@ -19,11 +24,14 @@ declare function generateGitCodeStoreProjectUploadUrl$1(httpClient: HttpClient):
 interface GenerateGitCodeStoreProjectUploadUrlSignature {
     /**
      * Generates a temporary, project-scoped URL for uploading a ZIP with HTTP PUT.
-     * PUT the ZIP with the returned headers, then call CommitGitCodeStoreProjectUpload. No size is required.
+     *
+     * PUT the ZIP with the returned headers, then call
+     * [Commit Git Code Store Project Upload](https://dev.wix.com/docs/api-reference/account-level/git-codestore/commit-git-code-store-project-upload).
      * The 64 MiB compressed size limit is checked when committing the upload, not by the signed PUT.
      * Uploading alone never changes the repository. ZIP paths must be relative to its root.
      * Requires an authenticated user with update access to the app or its companion site.
-     * @param - Managed project receiving the upload.
+     * @param - ID of the existing AppManagedProject receiving the upload.
+     * Use the same `managedProjectId` for downloading, uploading, and committing.
      */
     (managedProjectId: string): Promise<NonNullablePaths<GenerateGitCodeStoreProjectUploadUrlResponse, `uploadId` | `uploadUrl`, 0>>;
 }
@@ -31,6 +39,7 @@ declare function commitGitCodeStoreProjectUpload$1(httpClient: HttpClient): Comm
 interface CommitGitCodeStoreProjectUploadSignature {
     /**
      * Commits and pushes a previously uploaded ZIP's contents to an existing branch.
+     *
      * Replaces the complete tracked file tree. Does not publish or deploy the application.
      * Files omitted from the ZIP are deleted. Creates one child commit and preserves history; never resets the branch history.
      * Defaults to main. An empty ZIP intentionally removes all files. An unchanged tree creates no commit.
@@ -38,9 +47,12 @@ interface CommitGitCodeStoreProjectUploadSignature {
      * Force replaces the latest checked-out tree and preserves history; concurrent writes can still conflict.
      * Accepts at most 64 MiB compressed, 256 MiB expanded, and 10,000 ZIP entries.
      * Rejects unsafe paths, Git metadata, submodules, and symlinks outside the repository.
-     * After a timeout, inspect the head before retrying.
+     * After a timeout, call [Generate Git Code Store Project Download Url](https://dev.wix.com/docs/api-reference/account-level/git-codestore/generate-git-code-store-project-download-url)
+     * for the same branch with `revisionId` omitted.
+     * Compare its revision and downloaded tree with your intended changes before retrying.
+     * A changed head alone does not prove this request succeeded. Do not use force to recover from a timeout.
      * Requires an authenticated user with update access to the app or its companion site.
-     * @param - Managed project to update. Must be the same project that issued upload_id.
+     * @param - ID of the existing AppManagedProject to update. Must be the same project that issued `uploadId`.
      * @param - Identifier returned by GenerateGitCodeStoreProjectUploadUrl.
      * The ZIP must have been uploaded within the last hour.
      */

package/build/internal/cjs/index.typings.d.ts

@@ -85,7 +85,8 @@ interface GitCodeStoreProjectDeleted {
 }
 interface GenerateGitCodeStoreProjectDownloadUrlRequest {
     /**
-     * Managed project whose code will be downloaded.
+     * ID of the existing AppManagedProject whose code will be downloaded.
+     * This identifies the managed project, not its site or a legacy v1 Code Store project.
      * @format GUID
      */
     managedProjectId: string;
@@ -156,7 +157,8 @@ interface Author {
 }
 interface GenerateGitCodeStoreProjectUploadUrlRequest {
     /**
-     * Managed project receiving the upload.
+     * ID of the existing AppManagedProject receiving the upload.
+     * Use the same `managedProjectId` for downloading, uploading, and committing.
      * @format GUID
      */
     managedProjectId: string;
@@ -212,7 +214,7 @@ interface GenerateGitCodeStoreProjectStagedUploadDownloadUrlResponse {
 }
 interface CommitGitCodeStoreProjectUploadRequest {
     /**
-     * Managed project to update. Must be the same project that issued upload_id.
+     * ID of the existing AppManagedProject to update. Must be the same project that issued `uploadId`.
      * @format GUID
      */
     managedProjectId: string;
@@ -1039,10 +1041,15 @@ type CommitGitCodeStoreProjectUploadApplicationErrors = {
 };
 /**
  * Generates a temporary URL to download all tracked files at one revision as a ZIP.
+ *
  * Includes hidden directories, binary files and materialized LFS objects; excludes Git history.
- * Defaults to main. Supply the returned revision when committing uploaded code unless force is true.
+ * Defaults to main. Omit `revisionId` to download the current branch head.
+ * Supply the returned revision when committing uploaded code unless force is true.
+ * Supports at most 10,000 tracked files, 256 MiB expanded, and a 64 MiB ZIP.
+ * Rejects unsafe paths, submodules, special files, and dangling or escaping symlinks.
  * Requires an authenticated user with read access to the app or its companion site.
- * @param managedProjectId - Managed project whose code will be downloaded.
+ * @param managedProjectId - ID of the existing AppManagedProject whose code will be downloaded.
+ * This identifies the managed project, not its site or a legacy v1 Code Store project.
  * @public
  * @documentationMaturity preview
  * @requiredField managedProjectId
@@ -1068,11 +1075,14 @@ interface GenerateGitCodeStoreProjectDownloadUrlOptions {
 }
 /**
  * Generates a temporary, project-scoped URL for uploading a ZIP with HTTP PUT.
- * PUT the ZIP with the returned headers, then call CommitGitCodeStoreProjectUpload. No size is required.
+ *
+ * PUT the ZIP with the returned headers, then call
+ * [Commit Git Code Store Project Upload](https://dev.wix.com/docs/api-reference/account-level/git-codestore/commit-git-code-store-project-upload).
  * The 64 MiB compressed size limit is checked when committing the upload, not by the signed PUT.
  * Uploading alone never changes the repository. ZIP paths must be relative to its root.
  * Requires an authenticated user with update access to the app or its companion site.
- * @param managedProjectId - Managed project receiving the upload.
+ * @param managedProjectId - ID of the existing AppManagedProject receiving the upload.
+ * Use the same `managedProjectId` for downloading, uploading, and committing.
  * @public
  * @documentationMaturity preview
  * @requiredField managedProjectId
@@ -1082,6 +1092,7 @@ interface GenerateGitCodeStoreProjectDownloadUrlOptions {
 declare function generateGitCodeStoreProjectUploadUrl(managedProjectId: string): Promise<NonNullablePaths<GenerateGitCodeStoreProjectUploadUrlResponse, `uploadId` | `uploadUrl`, 0>>;
 /**
  * Commits and pushes a previously uploaded ZIP's contents to an existing branch.
+ *
  * Replaces the complete tracked file tree. Does not publish or deploy the application.
  * Files omitted from the ZIP are deleted. Creates one child commit and preserves history; never resets the branch history.
  * Defaults to main. An empty ZIP intentionally removes all files. An unchanged tree creates no commit.
@@ -1089,9 +1100,12 @@ declare function generateGitCodeStoreProjectUploadUrl(managedProjectId: string):
  * Force replaces the latest checked-out tree and preserves history; concurrent writes can still conflict.
  * Accepts at most 64 MiB compressed, 256 MiB expanded, and 10,000 ZIP entries.
  * Rejects unsafe paths, Git metadata, submodules, and symlinks outside the repository.
- * After a timeout, inspect the head before retrying.
+ * After a timeout, call [Generate Git Code Store Project Download Url](https://dev.wix.com/docs/api-reference/account-level/git-codestore/generate-git-code-store-project-download-url)
+ * for the same branch with `revisionId` omitted.
+ * Compare its revision and downloaded tree with your intended changes before retrying.
+ * A changed head alone does not prove this request succeeded. Do not use force to recover from a timeout.
  * Requires an authenticated user with update access to the app or its companion site.
- * @param managedProjectId - Managed project to update. Must be the same project that issued upload_id.
+ * @param managedProjectId - ID of the existing AppManagedProject to update. Must be the same project that issued `uploadId`.
  * @param uploadId - Identifier returned by GenerateGitCodeStoreProjectUploadUrl.
  * The ZIP must have been uploaded within the last hour.
  * @public

package/build/internal/cjs/meta.d.ts

@@ -86,7 +86,8 @@ interface GitCodeStoreProjectDeleted {
 }
 interface GenerateGitCodeStoreProjectDownloadUrlRequest {
     /**
-     * Managed project whose code will be downloaded.
+     * ID of the existing AppManagedProject whose code will be downloaded.
+     * This identifies the managed project, not its site or a legacy v1 Code Store project.
      * @format GUID
      */
     managedProjectId: string;
@@ -157,7 +158,8 @@ interface Author {
 }
 interface GenerateGitCodeStoreProjectUploadUrlRequest {
     /**
-     * Managed project receiving the upload.
+     * ID of the existing AppManagedProject receiving the upload.
+     * Use the same `managedProjectId` for downloading, uploading, and committing.
      * @format GUID
      */
     managedProjectId: string;
@@ -213,7 +215,7 @@ interface GenerateGitCodeStoreProjectStagedUploadDownloadUrlResponse {
 }
 interface CommitGitCodeStoreProjectUploadRequest {
     /**
-     * Managed project to update. Must be the same project that issued upload_id.
+     * ID of the existing AppManagedProject to update. Must be the same project that issued `uploadId`.
      * @format GUID
      */
     managedProjectId: string;

package/build/internal/es/index.d.mts

@@ -6,10 +6,15 @@ declare function generateGitCodeStoreProjectDownloadUrl$1(httpClient: HttpClient
 interface GenerateGitCodeStoreProjectDownloadUrlSignature {
     /**
      * Generates a temporary URL to download all tracked files at one revision as a ZIP.
+     *
      * Includes hidden directories, binary files and materialized LFS objects; excludes Git history.
-     * Defaults to main. Supply the returned revision when committing uploaded code unless force is true.
+     * Defaults to main. Omit `revisionId` to download the current branch head.
+     * Supply the returned revision when committing uploaded code unless force is true.
+     * Supports at most 10,000 tracked files, 256 MiB expanded, and a 64 MiB ZIP.
+     * Rejects unsafe paths, submodules, special files, and dangling or escaping symlinks.
      * Requires an authenticated user with read access to the app or its companion site.
-     * @param - Managed project whose code will be downloaded.
+     * @param - ID of the existing AppManagedProject whose code will be downloaded.
+     * This identifies the managed project, not its site or a legacy v1 Code Store project.
      */
     (managedProjectId: string, options?: GenerateGitCodeStoreProjectDownloadUrlOptions): Promise<NonNullablePaths<GenerateGitCodeStoreProjectDownloadUrlResponse, `downloadUrl` | `revision.author.name` | `revision.author.email` | `branchName`, 2> & {
         __applicationErrorsType?: GenerateGitCodeStoreProjectDownloadUrlApplicationErrors;
@@ -19,11 +24,14 @@ declare function generateGitCodeStoreProjectUploadUrl$1(httpClient: HttpClient):
 interface GenerateGitCodeStoreProjectUploadUrlSignature {
     /**
      * Generates a temporary, project-scoped URL for uploading a ZIP with HTTP PUT.
-     * PUT the ZIP with the returned headers, then call CommitGitCodeStoreProjectUpload. No size is required.
+     *
+     * PUT the ZIP with the returned headers, then call
+     * [Commit Git Code Store Project Upload](https://dev.wix.com/docs/api-reference/account-level/git-codestore/commit-git-code-store-project-upload).
      * The 64 MiB compressed size limit is checked when committing the upload, not by the signed PUT.
      * Uploading alone never changes the repository. ZIP paths must be relative to its root.
      * Requires an authenticated user with update access to the app or its companion site.
-     * @param - Managed project receiving the upload.
+     * @param - ID of the existing AppManagedProject receiving the upload.
+     * Use the same `managedProjectId` for downloading, uploading, and committing.
      */
     (managedProjectId: string): Promise<NonNullablePaths<GenerateGitCodeStoreProjectUploadUrlResponse, `uploadId` | `uploadUrl`, 0>>;
 }
@@ -31,6 +39,7 @@ declare function commitGitCodeStoreProjectUpload$1(httpClient: HttpClient): Comm
 interface CommitGitCodeStoreProjectUploadSignature {
     /**
      * Commits and pushes a previously uploaded ZIP's contents to an existing branch.
+     *
      * Replaces the complete tracked file tree. Does not publish or deploy the application.
      * Files omitted from the ZIP are deleted. Creates one child commit and preserves history; never resets the branch history.
      * Defaults to main. An empty ZIP intentionally removes all files. An unchanged tree creates no commit.
@@ -38,9 +47,12 @@ interface CommitGitCodeStoreProjectUploadSignature {
      * Force replaces the latest checked-out tree and preserves history; concurrent writes can still conflict.
      * Accepts at most 64 MiB compressed, 256 MiB expanded, and 10,000 ZIP entries.
      * Rejects unsafe paths, Git metadata, submodules, and symlinks outside the repository.
-     * After a timeout, inspect the head before retrying.
+     * After a timeout, call [Generate Git Code Store Project Download Url](https://dev.wix.com/docs/api-reference/account-level/git-codestore/generate-git-code-store-project-download-url)
+     * for the same branch with `revisionId` omitted.
+     * Compare its revision and downloaded tree with your intended changes before retrying.
+     * A changed head alone does not prove this request succeeded. Do not use force to recover from a timeout.
      * Requires an authenticated user with update access to the app or its companion site.
-     * @param - Managed project to update. Must be the same project that issued upload_id.
+     * @param - ID of the existing AppManagedProject to update. Must be the same project that issued `uploadId`.
      * @param - Identifier returned by GenerateGitCodeStoreProjectUploadUrl.
      * The ZIP must have been uploaded within the last hour.
      */

package/build/internal/es/index.typings.d.mts

@@ -85,7 +85,8 @@ interface GitCodeStoreProjectDeleted {
 }
 interface GenerateGitCodeStoreProjectDownloadUrlRequest {
     /**
-     * Managed project whose code will be downloaded.
+     * ID of the existing AppManagedProject whose code will be downloaded.
+     * This identifies the managed project, not its site or a legacy v1 Code Store project.
      * @format GUID
      */
     managedProjectId: string;
@@ -156,7 +157,8 @@ interface Author {
 }
 interface GenerateGitCodeStoreProjectUploadUrlRequest {
     /**
-     * Managed project receiving the upload.
+     * ID of the existing AppManagedProject receiving the upload.
+     * Use the same `managedProjectId` for downloading, uploading, and committing.
      * @format GUID
      */
     managedProjectId: string;
@@ -212,7 +214,7 @@ interface GenerateGitCodeStoreProjectStagedUploadDownloadUrlResponse {
 }
 interface CommitGitCodeStoreProjectUploadRequest {
     /**
-     * Managed project to update. Must be the same project that issued upload_id.
+     * ID of the existing AppManagedProject to update. Must be the same project that issued `uploadId`.
      * @format GUID
      */
     managedProjectId: string;
@@ -1039,10 +1041,15 @@ type CommitGitCodeStoreProjectUploadApplicationErrors = {
 };
 /**
  * Generates a temporary URL to download all tracked files at one revision as a ZIP.
+ *
  * Includes hidden directories, binary files and materialized LFS objects; excludes Git history.
- * Defaults to main. Supply the returned revision when committing uploaded code unless force is true.
+ * Defaults to main. Omit `revisionId` to download the current branch head.
+ * Supply the returned revision when committing uploaded code unless force is true.
+ * Supports at most 10,000 tracked files, 256 MiB expanded, and a 64 MiB ZIP.
+ * Rejects unsafe paths, submodules, special files, and dangling or escaping symlinks.
  * Requires an authenticated user with read access to the app or its companion site.
- * @param managedProjectId - Managed project whose code will be downloaded.
+ * @param managedProjectId - ID of the existing AppManagedProject whose code will be downloaded.
+ * This identifies the managed project, not its site or a legacy v1 Code Store project.
  * @public
  * @documentationMaturity preview
  * @requiredField managedProjectId
@@ -1068,11 +1075,14 @@ interface GenerateGitCodeStoreProjectDownloadUrlOptions {
 }
 /**
  * Generates a temporary, project-scoped URL for uploading a ZIP with HTTP PUT.
- * PUT the ZIP with the returned headers, then call CommitGitCodeStoreProjectUpload. No size is required.
+ *
+ * PUT the ZIP with the returned headers, then call
+ * [Commit Git Code Store Project Upload](https://dev.wix.com/docs/api-reference/account-level/git-codestore/commit-git-code-store-project-upload).
  * The 64 MiB compressed size limit is checked when committing the upload, not by the signed PUT.
  * Uploading alone never changes the repository. ZIP paths must be relative to its root.
  * Requires an authenticated user with update access to the app or its companion site.
- * @param managedProjectId - Managed project receiving the upload.
+ * @param managedProjectId - ID of the existing AppManagedProject receiving the upload.
+ * Use the same `managedProjectId` for downloading, uploading, and committing.
  * @public
  * @documentationMaturity preview
  * @requiredField managedProjectId
@@ -1082,6 +1092,7 @@ interface GenerateGitCodeStoreProjectDownloadUrlOptions {
 declare function generateGitCodeStoreProjectUploadUrl(managedProjectId: string): Promise<NonNullablePaths<GenerateGitCodeStoreProjectUploadUrlResponse, `uploadId` | `uploadUrl`, 0>>;
 /**
  * Commits and pushes a previously uploaded ZIP's contents to an existing branch.
+ *
  * Replaces the complete tracked file tree. Does not publish or deploy the application.
  * Files omitted from the ZIP are deleted. Creates one child commit and preserves history; never resets the branch history.
  * Defaults to main. An empty ZIP intentionally removes all files. An unchanged tree creates no commit.
@@ -1089,9 +1100,12 @@ declare function generateGitCodeStoreProjectUploadUrl(managedProjectId: string):
  * Force replaces the latest checked-out tree and preserves history; concurrent writes can still conflict.
  * Accepts at most 64 MiB compressed, 256 MiB expanded, and 10,000 ZIP entries.
  * Rejects unsafe paths, Git metadata, submodules, and symlinks outside the repository.
- * After a timeout, inspect the head before retrying.
+ * After a timeout, call [Generate Git Code Store Project Download Url](https://dev.wix.com/docs/api-reference/account-level/git-codestore/generate-git-code-store-project-download-url)
+ * for the same branch with `revisionId` omitted.
+ * Compare its revision and downloaded tree with your intended changes before retrying.
+ * A changed head alone does not prove this request succeeded. Do not use force to recover from a timeout.
  * Requires an authenticated user with update access to the app or its companion site.
- * @param managedProjectId - Managed project to update. Must be the same project that issued upload_id.
+ * @param managedProjectId - ID of the existing AppManagedProject to update. Must be the same project that issued `uploadId`.
  * @param uploadId - Identifier returned by GenerateGitCodeStoreProjectUploadUrl.
  * The ZIP must have been uploaded within the last hour.
  * @public

package/build/internal/es/meta.d.mts

@@ -86,7 +86,8 @@ interface GitCodeStoreProjectDeleted {
 }
 interface GenerateGitCodeStoreProjectDownloadUrlRequest {
     /**
-     * Managed project whose code will be downloaded.
+     * ID of the existing AppManagedProject whose code will be downloaded.
+     * This identifies the managed project, not its site or a legacy v1 Code Store project.
      * @format GUID
      */
     managedProjectId: string;
@@ -157,7 +158,8 @@ interface Author {
 }
 interface GenerateGitCodeStoreProjectUploadUrlRequest {
     /**
-     * Managed project receiving the upload.
+     * ID of the existing AppManagedProject receiving the upload.
+     * Use the same `managedProjectId` for downloading, uploading, and committing.
      * @format GUID
      */
     managedProjectId: string;
@@ -213,7 +215,7 @@ interface GenerateGitCodeStoreProjectStagedUploadDownloadUrlResponse {
 }
 interface CommitGitCodeStoreProjectUploadRequest {
     /**
-     * Managed project to update. Must be the same project that issued upload_id.
+     * ID of the existing AppManagedProject to update. Must be the same project that issued `uploadId`.
      * @format GUID
      */
     managedProjectId: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto_sdk_git-code-store_projects",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "license": "MIT",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -50,5 +50,5 @@
       "fqdn": "wix.codestore.v2.project"
     }
   },
-  "falconPackageHash": "4093c1b342e05c5c9610642cf8116b9df391880b8ca568ea5d100656"
+  "falconPackageHash": "5f3b951b94fa6e685e238e1e344b734335ec6a1dd9d985c2cd02e7b4"
 }