@wix/auto_sdk_git-code-store_projects 1.0.1 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -6,8 +6,9 @@ declare function generateGitCodeStoreProjectDownloadUrl$1(httpClient: HttpClient
6
6
  interface GenerateGitCodeStoreProjectDownloadUrlSignature {
7
7
  /**
8
8
  * Generates a temporary URL to download all tracked files at one revision as a ZIP.
9
+ *
9
10
  * Includes hidden directories, binary files and materialized LFS objects; excludes Git history.
10
- * Defaults to main. Omit revision_id to download the current branch head.
11
+ * Defaults to main. Omit `revisionId` to download the current branch head.
11
12
  * Supply the returned revision when committing uploaded code unless force is true.
12
13
  * Supports at most 10,000 tracked files, 256 MiB expanded, and a 64 MiB ZIP.
13
14
  * Rejects unsafe paths, submodules, special files, and dangling or escaping symlinks.
@@ -23,12 +24,14 @@ declare function generateGitCodeStoreProjectUploadUrl$1(httpClient: HttpClient):
23
24
  interface GenerateGitCodeStoreProjectUploadUrlSignature {
24
25
  /**
25
26
  * Generates a temporary, project-scoped URL for uploading a ZIP with HTTP PUT.
26
- * PUT the ZIP with the returned headers, then call CommitGitCodeStoreProjectUpload. No size is required.
27
+ *
28
+ * PUT the ZIP with the returned headers, then call
29
+ * [Commit Git Code Store Project Upload](https://dev.wix.com/docs/api-reference/account-level/git-codestore/commit-git-code-store-project-upload).
27
30
  * The 64 MiB compressed size limit is checked when committing the upload, not by the signed PUT.
28
31
  * Uploading alone never changes the repository. ZIP paths must be relative to its root.
29
32
  * Requires an authenticated user with update access to the app or its companion site.
30
33
  * @param - ID of the existing AppManagedProject receiving the upload.
31
- * Use the same managed_project_id for downloading, uploading, and committing.
34
+ * Use the same `managedProjectId` for downloading, uploading, and committing.
32
35
  */
33
36
  (managedProjectId: string): Promise<NonNullablePaths<GenerateGitCodeStoreProjectUploadUrlResponse, `uploadId` | `uploadUrl`, 0>>;
34
37
  }
@@ -36,6 +39,7 @@ declare function commitGitCodeStoreProjectUpload$1(httpClient: HttpClient): Comm
36
39
  interface CommitGitCodeStoreProjectUploadSignature {
37
40
  /**
38
41
  * Commits and pushes a previously uploaded ZIP's contents to an existing branch.
42
+ *
39
43
  * Replaces the complete tracked file tree. Does not publish or deploy the application.
40
44
  * Files omitted from the ZIP are deleted. Creates one child commit and preserves history; never resets the branch history.
41
45
  * Defaults to main. An empty ZIP intentionally removes all files. An unchanged tree creates no commit.
@@ -43,11 +47,12 @@ interface CommitGitCodeStoreProjectUploadSignature {
43
47
  * Force replaces the latest checked-out tree and preserves history; concurrent writes can still conflict.
44
48
  * Accepts at most 64 MiB compressed, 256 MiB expanded, and 10,000 ZIP entries.
45
49
  * Rejects unsafe paths, Git metadata, submodules, and symlinks outside the repository.
46
- * After a timeout, call GenerateGitCodeStoreProjectDownloadUrl for the same branch with revision_id omitted.
50
+ * 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)
51
+ * for the same branch with `revisionId` omitted.
47
52
  * Compare its revision and downloaded tree with your intended changes before retrying.
48
53
  * A changed head alone does not prove this request succeeded. Do not use force to recover from a timeout.
49
54
  * Requires an authenticated user with update access to the app or its companion site.
50
- * @param - ID of the existing AppManagedProject to update. Must be the same project that issued upload_id.
55
+ * @param - ID of the existing AppManagedProject to update. Must be the same project that issued `uploadId`.
51
56
  * @param - Identifier returned by GenerateGitCodeStoreProjectUploadUrl.
52
57
  * The ZIP must have been uploaded within the last hour.
53
58
  */
@@ -158,7 +158,7 @@ interface Author {
158
158
  interface GenerateGitCodeStoreProjectUploadUrlRequest {
159
159
  /**
160
160
  * ID of the existing AppManagedProject receiving the upload.
161
- * Use the same managed_project_id for downloading, uploading, and committing.
161
+ * Use the same `managedProjectId` for downloading, uploading, and committing.
162
162
  * @format GUID
163
163
  */
164
164
  managedProjectId: string;
@@ -214,7 +214,7 @@ interface GenerateGitCodeStoreProjectStagedUploadDownloadUrlResponse {
214
214
  }
215
215
  interface CommitGitCodeStoreProjectUploadRequest {
216
216
  /**
217
- * ID of the existing AppManagedProject to update. Must be the same project that issued upload_id.
217
+ * ID of the existing AppManagedProject to update. Must be the same project that issued `uploadId`.
218
218
  * @format GUID
219
219
  */
220
220
  managedProjectId: string;
@@ -1041,8 +1041,9 @@ type CommitGitCodeStoreProjectUploadApplicationErrors = {
1041
1041
  };
1042
1042
  /**
1043
1043
  * Generates a temporary URL to download all tracked files at one revision as a ZIP.
1044
+ *
1044
1045
  * Includes hidden directories, binary files and materialized LFS objects; excludes Git history.
1045
- * Defaults to main. Omit revision_id to download the current branch head.
1046
+ * Defaults to main. Omit `revisionId` to download the current branch head.
1046
1047
  * Supply the returned revision when committing uploaded code unless force is true.
1047
1048
  * Supports at most 10,000 tracked files, 256 MiB expanded, and a 64 MiB ZIP.
1048
1049
  * Rejects unsafe paths, submodules, special files, and dangling or escaping symlinks.
@@ -1074,12 +1075,14 @@ interface GenerateGitCodeStoreProjectDownloadUrlOptions {
1074
1075
  }
1075
1076
  /**
1076
1077
  * Generates a temporary, project-scoped URL for uploading a ZIP with HTTP PUT.
1077
- * PUT the ZIP with the returned headers, then call CommitGitCodeStoreProjectUpload. No size is required.
1078
+ *
1079
+ * PUT the ZIP with the returned headers, then call
1080
+ * [Commit Git Code Store Project Upload](https://dev.wix.com/docs/api-reference/account-level/git-codestore/commit-git-code-store-project-upload).
1078
1081
  * The 64 MiB compressed size limit is checked when committing the upload, not by the signed PUT.
1079
1082
  * Uploading alone never changes the repository. ZIP paths must be relative to its root.
1080
1083
  * Requires an authenticated user with update access to the app or its companion site.
1081
1084
  * @param managedProjectId - ID of the existing AppManagedProject receiving the upload.
1082
- * Use the same managed_project_id for downloading, uploading, and committing.
1085
+ * Use the same `managedProjectId` for downloading, uploading, and committing.
1083
1086
  * @public
1084
1087
  * @documentationMaturity preview
1085
1088
  * @requiredField managedProjectId
@@ -1089,6 +1092,7 @@ interface GenerateGitCodeStoreProjectDownloadUrlOptions {
1089
1092
  declare function generateGitCodeStoreProjectUploadUrl(managedProjectId: string): Promise<NonNullablePaths<GenerateGitCodeStoreProjectUploadUrlResponse, `uploadId` | `uploadUrl`, 0>>;
1090
1093
  /**
1091
1094
  * Commits and pushes a previously uploaded ZIP's contents to an existing branch.
1095
+ *
1092
1096
  * Replaces the complete tracked file tree. Does not publish or deploy the application.
1093
1097
  * Files omitted from the ZIP are deleted. Creates one child commit and preserves history; never resets the branch history.
1094
1098
  * Defaults to main. An empty ZIP intentionally removes all files. An unchanged tree creates no commit.
@@ -1096,11 +1100,12 @@ declare function generateGitCodeStoreProjectUploadUrl(managedProjectId: string):
1096
1100
  * Force replaces the latest checked-out tree and preserves history; concurrent writes can still conflict.
1097
1101
  * Accepts at most 64 MiB compressed, 256 MiB expanded, and 10,000 ZIP entries.
1098
1102
  * Rejects unsafe paths, Git metadata, submodules, and symlinks outside the repository.
1099
- * After a timeout, call GenerateGitCodeStoreProjectDownloadUrl for the same branch with revision_id omitted.
1103
+ * 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)
1104
+ * for the same branch with `revisionId` omitted.
1100
1105
  * Compare its revision and downloaded tree with your intended changes before retrying.
1101
1106
  * A changed head alone does not prove this request succeeded. Do not use force to recover from a timeout.
1102
1107
  * Requires an authenticated user with update access to the app or its companion site.
1103
- * @param managedProjectId - ID of the existing AppManagedProject to update. Must be the same project that issued upload_id.
1108
+ * @param managedProjectId - ID of the existing AppManagedProject to update. Must be the same project that issued `uploadId`.
1104
1109
  * @param uploadId - Identifier returned by GenerateGitCodeStoreProjectUploadUrl.
1105
1110
  * The ZIP must have been uploaded within the last hour.
1106
1111
  * @public
@@ -159,7 +159,7 @@ interface Author {
159
159
  interface GenerateGitCodeStoreProjectUploadUrlRequest {
160
160
  /**
161
161
  * ID of the existing AppManagedProject receiving the upload.
162
- * Use the same managed_project_id for downloading, uploading, and committing.
162
+ * Use the same `managedProjectId` for downloading, uploading, and committing.
163
163
  * @format GUID
164
164
  */
165
165
  managedProjectId: string;
@@ -215,7 +215,7 @@ interface GenerateGitCodeStoreProjectStagedUploadDownloadUrlResponse {
215
215
  }
216
216
  interface CommitGitCodeStoreProjectUploadRequest {
217
217
  /**
218
- * ID of the existing AppManagedProject to update. Must be the same project that issued upload_id.
218
+ * ID of the existing AppManagedProject to update. Must be the same project that issued `uploadId`.
219
219
  * @format GUID
220
220
  */
221
221
  managedProjectId: string;
@@ -6,8 +6,9 @@ declare function generateGitCodeStoreProjectDownloadUrl$1(httpClient: HttpClient
6
6
  interface GenerateGitCodeStoreProjectDownloadUrlSignature {
7
7
  /**
8
8
  * Generates a temporary URL to download all tracked files at one revision as a ZIP.
9
+ *
9
10
  * Includes hidden directories, binary files and materialized LFS objects; excludes Git history.
10
- * Defaults to main. Omit revision_id to download the current branch head.
11
+ * Defaults to main. Omit `revisionId` to download the current branch head.
11
12
  * Supply the returned revision when committing uploaded code unless force is true.
12
13
  * Supports at most 10,000 tracked files, 256 MiB expanded, and a 64 MiB ZIP.
13
14
  * Rejects unsafe paths, submodules, special files, and dangling or escaping symlinks.
@@ -23,12 +24,14 @@ declare function generateGitCodeStoreProjectUploadUrl$1(httpClient: HttpClient):
23
24
  interface GenerateGitCodeStoreProjectUploadUrlSignature {
24
25
  /**
25
26
  * Generates a temporary, project-scoped URL for uploading a ZIP with HTTP PUT.
26
- * PUT the ZIP with the returned headers, then call CommitGitCodeStoreProjectUpload. No size is required.
27
+ *
28
+ * PUT the ZIP with the returned headers, then call
29
+ * [Commit Git Code Store Project Upload](https://dev.wix.com/docs/api-reference/account-level/git-codestore/commit-git-code-store-project-upload).
27
30
  * The 64 MiB compressed size limit is checked when committing the upload, not by the signed PUT.
28
31
  * Uploading alone never changes the repository. ZIP paths must be relative to its root.
29
32
  * Requires an authenticated user with update access to the app or its companion site.
30
33
  * @param - ID of the existing AppManagedProject receiving the upload.
31
- * Use the same managed_project_id for downloading, uploading, and committing.
34
+ * Use the same `managedProjectId` for downloading, uploading, and committing.
32
35
  */
33
36
  (managedProjectId: string): Promise<NonNullablePaths<GenerateGitCodeStoreProjectUploadUrlResponse, `uploadId` | `uploadUrl`, 0>>;
34
37
  }
@@ -36,6 +39,7 @@ declare function commitGitCodeStoreProjectUpload$1(httpClient: HttpClient): Comm
36
39
  interface CommitGitCodeStoreProjectUploadSignature {
37
40
  /**
38
41
  * Commits and pushes a previously uploaded ZIP's contents to an existing branch.
42
+ *
39
43
  * Replaces the complete tracked file tree. Does not publish or deploy the application.
40
44
  * Files omitted from the ZIP are deleted. Creates one child commit and preserves history; never resets the branch history.
41
45
  * Defaults to main. An empty ZIP intentionally removes all files. An unchanged tree creates no commit.
@@ -43,11 +47,12 @@ interface CommitGitCodeStoreProjectUploadSignature {
43
47
  * Force replaces the latest checked-out tree and preserves history; concurrent writes can still conflict.
44
48
  * Accepts at most 64 MiB compressed, 256 MiB expanded, and 10,000 ZIP entries.
45
49
  * Rejects unsafe paths, Git metadata, submodules, and symlinks outside the repository.
46
- * After a timeout, call GenerateGitCodeStoreProjectDownloadUrl for the same branch with revision_id omitted.
50
+ * 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)
51
+ * for the same branch with `revisionId` omitted.
47
52
  * Compare its revision and downloaded tree with your intended changes before retrying.
48
53
  * A changed head alone does not prove this request succeeded. Do not use force to recover from a timeout.
49
54
  * Requires an authenticated user with update access to the app or its companion site.
50
- * @param - ID of the existing AppManagedProject to update. Must be the same project that issued upload_id.
55
+ * @param - ID of the existing AppManagedProject to update. Must be the same project that issued `uploadId`.
51
56
  * @param - Identifier returned by GenerateGitCodeStoreProjectUploadUrl.
52
57
  * The ZIP must have been uploaded within the last hour.
53
58
  */
@@ -158,7 +158,7 @@ interface Author {
158
158
  interface GenerateGitCodeStoreProjectUploadUrlRequest {
159
159
  /**
160
160
  * ID of the existing AppManagedProject receiving the upload.
161
- * Use the same managed_project_id for downloading, uploading, and committing.
161
+ * Use the same `managedProjectId` for downloading, uploading, and committing.
162
162
  * @format GUID
163
163
  */
164
164
  managedProjectId: string;
@@ -214,7 +214,7 @@ interface GenerateGitCodeStoreProjectStagedUploadDownloadUrlResponse {
214
214
  }
215
215
  interface CommitGitCodeStoreProjectUploadRequest {
216
216
  /**
217
- * ID of the existing AppManagedProject to update. Must be the same project that issued upload_id.
217
+ * ID of the existing AppManagedProject to update. Must be the same project that issued `uploadId`.
218
218
  * @format GUID
219
219
  */
220
220
  managedProjectId: string;
@@ -1041,8 +1041,9 @@ type CommitGitCodeStoreProjectUploadApplicationErrors = {
1041
1041
  };
1042
1042
  /**
1043
1043
  * Generates a temporary URL to download all tracked files at one revision as a ZIP.
1044
+ *
1044
1045
  * Includes hidden directories, binary files and materialized LFS objects; excludes Git history.
1045
- * Defaults to main. Omit revision_id to download the current branch head.
1046
+ * Defaults to main. Omit `revisionId` to download the current branch head.
1046
1047
  * Supply the returned revision when committing uploaded code unless force is true.
1047
1048
  * Supports at most 10,000 tracked files, 256 MiB expanded, and a 64 MiB ZIP.
1048
1049
  * Rejects unsafe paths, submodules, special files, and dangling or escaping symlinks.
@@ -1074,12 +1075,14 @@ interface GenerateGitCodeStoreProjectDownloadUrlOptions {
1074
1075
  }
1075
1076
  /**
1076
1077
  * Generates a temporary, project-scoped URL for uploading a ZIP with HTTP PUT.
1077
- * PUT the ZIP with the returned headers, then call CommitGitCodeStoreProjectUpload. No size is required.
1078
+ *
1079
+ * PUT the ZIP with the returned headers, then call
1080
+ * [Commit Git Code Store Project Upload](https://dev.wix.com/docs/api-reference/account-level/git-codestore/commit-git-code-store-project-upload).
1078
1081
  * The 64 MiB compressed size limit is checked when committing the upload, not by the signed PUT.
1079
1082
  * Uploading alone never changes the repository. ZIP paths must be relative to its root.
1080
1083
  * Requires an authenticated user with update access to the app or its companion site.
1081
1084
  * @param managedProjectId - ID of the existing AppManagedProject receiving the upload.
1082
- * Use the same managed_project_id for downloading, uploading, and committing.
1085
+ * Use the same `managedProjectId` for downloading, uploading, and committing.
1083
1086
  * @public
1084
1087
  * @documentationMaturity preview
1085
1088
  * @requiredField managedProjectId
@@ -1089,6 +1092,7 @@ interface GenerateGitCodeStoreProjectDownloadUrlOptions {
1089
1092
  declare function generateGitCodeStoreProjectUploadUrl(managedProjectId: string): Promise<NonNullablePaths<GenerateGitCodeStoreProjectUploadUrlResponse, `uploadId` | `uploadUrl`, 0>>;
1090
1093
  /**
1091
1094
  * Commits and pushes a previously uploaded ZIP's contents to an existing branch.
1095
+ *
1092
1096
  * Replaces the complete tracked file tree. Does not publish or deploy the application.
1093
1097
  * Files omitted from the ZIP are deleted. Creates one child commit and preserves history; never resets the branch history.
1094
1098
  * Defaults to main. An empty ZIP intentionally removes all files. An unchanged tree creates no commit.
@@ -1096,11 +1100,12 @@ declare function generateGitCodeStoreProjectUploadUrl(managedProjectId: string):
1096
1100
  * Force replaces the latest checked-out tree and preserves history; concurrent writes can still conflict.
1097
1101
  * Accepts at most 64 MiB compressed, 256 MiB expanded, and 10,000 ZIP entries.
1098
1102
  * Rejects unsafe paths, Git metadata, submodules, and symlinks outside the repository.
1099
- * After a timeout, call GenerateGitCodeStoreProjectDownloadUrl for the same branch with revision_id omitted.
1103
+ * 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)
1104
+ * for the same branch with `revisionId` omitted.
1100
1105
  * Compare its revision and downloaded tree with your intended changes before retrying.
1101
1106
  * A changed head alone does not prove this request succeeded. Do not use force to recover from a timeout.
1102
1107
  * Requires an authenticated user with update access to the app or its companion site.
1103
- * @param managedProjectId - ID of the existing AppManagedProject to update. Must be the same project that issued upload_id.
1108
+ * @param managedProjectId - ID of the existing AppManagedProject to update. Must be the same project that issued `uploadId`.
1104
1109
  * @param uploadId - Identifier returned by GenerateGitCodeStoreProjectUploadUrl.
1105
1110
  * The ZIP must have been uploaded within the last hour.
1106
1111
  * @public
@@ -159,7 +159,7 @@ interface Author {
159
159
  interface GenerateGitCodeStoreProjectUploadUrlRequest {
160
160
  /**
161
161
  * ID of the existing AppManagedProject receiving the upload.
162
- * Use the same managed_project_id for downloading, uploading, and committing.
162
+ * Use the same `managedProjectId` for downloading, uploading, and committing.
163
163
  * @format GUID
164
164
  */
165
165
  managedProjectId: string;
@@ -215,7 +215,7 @@ interface GenerateGitCodeStoreProjectStagedUploadDownloadUrlResponse {
215
215
  }
216
216
  interface CommitGitCodeStoreProjectUploadRequest {
217
217
  /**
218
- * ID of the existing AppManagedProject to update. Must be the same project that issued upload_id.
218
+ * ID of the existing AppManagedProject to update. Must be the same project that issued `uploadId`.
219
219
  * @format GUID
220
220
  */
221
221
  managedProjectId: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/auto_sdk_git-code-store_projects",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
4
4
  "license": "MIT",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/",
@@ -50,5 +50,5 @@
50
50
  "fqdn": "wix.codestore.v2.project"
51
51
  }
52
52
  },
53
- "falconPackageHash": "7cf33324149e5fec11227975cc65a7607c5e7c9c0e511b0752ae1975"
53
+ "falconPackageHash": "5f3b951b94fa6e685e238e1e344b734335ec6a1dd9d985c2cd02e7b4"
54
54
  }