@iconify/tools 4.0.0-beta.9 → 4.0.0

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.
Files changed (221) hide show
  1. package/lib/colors/attribs.d.cts +27 -0
  2. package/lib/colors/attribs.d.mts +27 -0
  3. package/lib/colors/attribs.d.ts +1 -1
  4. package/lib/colors/detect.d.cts +16 -0
  5. package/lib/colors/detect.d.mts +16 -0
  6. package/lib/colors/parse.d.cts +60 -0
  7. package/lib/colors/parse.d.mts +60 -0
  8. package/lib/colors/parse.d.ts +1 -1
  9. package/lib/colors/validate.d.cts +20 -0
  10. package/lib/colors/validate.d.mts +20 -0
  11. package/lib/css/parse.d.cts +6 -0
  12. package/lib/css/parse.d.mts +6 -0
  13. package/lib/css/parser/error.d.cts +13 -0
  14. package/lib/css/parser/error.d.mts +13 -0
  15. package/lib/css/parser/error.d.ts +1 -1
  16. package/lib/css/parser/export.d.cts +8 -0
  17. package/lib/css/parser/export.d.mts +8 -0
  18. package/lib/css/parser/strings.d.cts +16 -0
  19. package/lib/css/parser/strings.d.mts +16 -0
  20. package/lib/css/parser/text.d.cts +20 -0
  21. package/lib/css/parser/text.d.mts +20 -0
  22. package/lib/css/parser/tokens.d.cts +9 -0
  23. package/lib/css/parser/tokens.d.mts +9 -0
  24. package/lib/css/parser/tree.d.cts +8 -0
  25. package/lib/css/parser/tree.d.mts +8 -0
  26. package/lib/css/parser/types.d.cts +52 -0
  27. package/lib/css/parser/types.d.mts +52 -0
  28. package/lib/css/parser/types.d.ts +1 -1
  29. package/lib/download/api/cache.d.cts +20 -0
  30. package/lib/download/api/cache.d.mts +20 -0
  31. package/lib/download/api/config.d.cts +18 -0
  32. package/lib/download/api/config.d.mts +18 -0
  33. package/lib/download/api/download.d.cts +8 -0
  34. package/lib/download/api/download.d.mts +8 -0
  35. package/lib/download/api/index.d.cts +8 -0
  36. package/lib/download/api/index.d.mts +8 -0
  37. package/lib/download/api/queue.d.cts +32 -0
  38. package/lib/download/api/queue.d.mts +32 -0
  39. package/lib/download/api/queue.d.ts +1 -1
  40. package/lib/download/api/types.d.cts +17 -0
  41. package/lib/download/api/types.d.mts +17 -0
  42. package/lib/download/api/types.d.ts +1 -1
  43. package/lib/download/git/branch.d.cts +8 -0
  44. package/lib/download/git/branch.d.mts +8 -0
  45. package/lib/download/git/hash.d.cts +8 -0
  46. package/lib/download/git/hash.d.mts +8 -0
  47. package/lib/download/git/index.d.cts +29 -0
  48. package/lib/download/git/index.d.mts +29 -0
  49. package/lib/download/git/index.d.ts +1 -1
  50. package/lib/download/git/reset.d.cts +6 -0
  51. package/lib/download/git/reset.d.mts +6 -0
  52. package/lib/download/github/hash.d.cts +8 -0
  53. package/lib/download/github/hash.d.mts +8 -0
  54. package/lib/download/github/index.d.cts +31 -0
  55. package/lib/download/github/index.d.mts +31 -0
  56. package/lib/download/github/index.d.ts +1 -1
  57. package/lib/download/github/types.d.cts +11 -0
  58. package/lib/download/github/types.d.mts +11 -0
  59. package/lib/download/github/types.d.ts +1 -1
  60. package/lib/download/gitlab/hash.d.cts +8 -0
  61. package/lib/download/gitlab/hash.d.mts +8 -0
  62. package/lib/download/gitlab/index.d.cts +31 -0
  63. package/lib/download/gitlab/index.d.mts +31 -0
  64. package/lib/download/gitlab/index.d.ts +1 -1
  65. package/lib/download/gitlab/types.d.cts +15 -0
  66. package/lib/download/gitlab/types.d.mts +15 -0
  67. package/lib/download/gitlab/types.d.ts +1 -1
  68. package/lib/download/helpers/untar.d.cts +6 -0
  69. package/lib/download/helpers/untar.d.mts +6 -0
  70. package/lib/download/helpers/unzip.d.cts +6 -0
  71. package/lib/download/helpers/unzip.d.mts +6 -0
  72. package/lib/download/index.d.cts +48 -0
  73. package/lib/download/index.d.mts +48 -0
  74. package/lib/download/index.d.ts +1 -1
  75. package/lib/download/npm/index.d.cts +30 -0
  76. package/lib/download/npm/index.d.mts +30 -0
  77. package/lib/download/npm/index.d.ts +1 -1
  78. package/lib/download/npm/types.d.cts +9 -0
  79. package/lib/download/npm/types.d.mts +9 -0
  80. package/lib/download/npm/types.d.ts +1 -1
  81. package/lib/download/npm/version.d.cts +16 -0
  82. package/lib/download/npm/version.d.mts +16 -0
  83. package/lib/download/npm/version.d.ts +1 -1
  84. package/lib/download/types/modified.d.cts +6 -0
  85. package/lib/download/types/modified.d.mts +6 -0
  86. package/lib/download/types/modified.d.ts +1 -1
  87. package/lib/download/types/sources.d.cts +12 -0
  88. package/lib/download/types/sources.d.mts +12 -0
  89. package/lib/download/types/sources.d.ts +1 -1
  90. package/lib/export/directory.d.cts +26 -0
  91. package/lib/export/directory.d.mts +26 -0
  92. package/lib/export/directory.d.ts +1 -1
  93. package/lib/export/helpers/custom-files.d.cts +12 -0
  94. package/lib/export/helpers/custom-files.d.mts +12 -0
  95. package/lib/export/helpers/custom-files.d.ts +1 -1
  96. package/lib/export/helpers/prepare.d.cts +19 -0
  97. package/lib/export/helpers/prepare.d.mts +19 -0
  98. package/lib/export/helpers/prepare.d.ts +1 -1
  99. package/lib/export/helpers/types-version.d.cts +6 -0
  100. package/lib/export/helpers/types-version.d.mts +6 -0
  101. package/lib/export/icon-package.d.cts +26 -0
  102. package/lib/export/icon-package.d.mts +26 -0
  103. package/lib/export/icon-package.d.ts +1 -3
  104. package/lib/export/json-package.d.cts +25 -0
  105. package/lib/export/json-package.d.mts +25 -0
  106. package/lib/export/json-package.d.ts +1 -1
  107. package/lib/icon-set/index.cjs +22 -0
  108. package/lib/icon-set/index.d.cts +162 -0
  109. package/lib/icon-set/index.d.mts +162 -0
  110. package/lib/icon-set/index.mjs +22 -0
  111. package/lib/icon-set/match.d.cts +15 -0
  112. package/lib/icon-set/match.d.mts +15 -0
  113. package/lib/icon-set/merge.d.cts +14 -0
  114. package/lib/icon-set/merge.d.mts +14 -0
  115. package/lib/icon-set/modified.d.cts +16 -0
  116. package/lib/icon-set/modified.d.mts +16 -0
  117. package/lib/icon-set/props.d.cts +13 -0
  118. package/lib/icon-set/props.d.mts +13 -0
  119. package/lib/icon-set/tags.d.cts +23 -0
  120. package/lib/icon-set/tags.d.mts +23 -0
  121. package/lib/icon-set/types.d.cts +75 -0
  122. package/lib/icon-set/types.d.mts +75 -0
  123. package/lib/icon-set/types.d.ts +1 -1
  124. package/lib/import/directory.d.cts +52 -0
  125. package/lib/import/directory.d.mts +52 -0
  126. package/lib/import/directory.d.ts +1 -1
  127. package/lib/import/figma/index.d.cts +20 -0
  128. package/lib/import/figma/index.d.mts +20 -0
  129. package/lib/import/figma/nodes.d.cts +18 -0
  130. package/lib/import/figma/nodes.d.mts +18 -0
  131. package/lib/import/figma/query.d.cts +42 -0
  132. package/lib/import/figma/query.d.mts +42 -0
  133. package/lib/import/figma/query.d.ts +1 -1
  134. package/lib/import/figma/types/api.d.cts +53 -0
  135. package/lib/import/figma/types/api.d.mts +53 -0
  136. package/lib/import/figma/types/api.d.ts +1 -1
  137. package/lib/import/figma/types/nodes.d.cts +44 -0
  138. package/lib/import/figma/types/nodes.d.mts +44 -0
  139. package/lib/import/figma/types/nodes.d.ts +1 -1
  140. package/lib/import/figma/types/options.d.cts +59 -0
  141. package/lib/import/figma/types/options.d.mts +59 -0
  142. package/lib/import/figma/types/options.d.ts +1 -1
  143. package/lib/import/figma/types/result.d.cts +44 -0
  144. package/lib/import/figma/types/result.d.mts +44 -0
  145. package/lib/import/figma/types/result.d.ts +1 -1
  146. package/lib/index.cjs +7 -5
  147. package/lib/index.d.cts +78 -0
  148. package/lib/index.d.mts +78 -0
  149. package/lib/index.d.ts +1 -0
  150. package/lib/index.mjs +6 -5
  151. package/lib/misc/bump-version.d.cts +6 -0
  152. package/lib/misc/bump-version.d.mts +6 -0
  153. package/lib/misc/cheerio.d.cts +9 -0
  154. package/lib/misc/cheerio.d.mts +9 -0
  155. package/lib/misc/cheerio.d.ts +1 -1
  156. package/lib/misc/compare-dirs.d.cts +11 -0
  157. package/lib/misc/compare-dirs.d.mts +11 -0
  158. package/lib/misc/compare-dirs.d.ts +1 -1
  159. package/lib/misc/exec.d.cts +12 -0
  160. package/lib/misc/exec.d.mts +12 -0
  161. package/lib/misc/exec.d.ts +1 -1
  162. package/lib/misc/keyword.d.cts +6 -0
  163. package/lib/misc/keyword.d.mts +6 -0
  164. package/lib/misc/scan.d.cts +33 -0
  165. package/lib/misc/scan.d.mts +33 -0
  166. package/lib/misc/scan.d.ts +1 -1
  167. package/lib/misc/write-json.d.cts +6 -0
  168. package/lib/misc/write-json.d.mts +6 -0
  169. package/lib/optimise/figma.d.cts +11 -0
  170. package/lib/optimise/figma.d.mts +11 -0
  171. package/lib/optimise/flags.d.cts +11 -0
  172. package/lib/optimise/flags.d.mts +11 -0
  173. package/lib/optimise/global-style.d.cts +11 -0
  174. package/lib/optimise/global-style.d.mts +11 -0
  175. package/lib/optimise/mask.d.cts +24 -0
  176. package/lib/optimise/mask.d.mts +24 -0
  177. package/lib/optimise/origin.d.cts +11 -0
  178. package/lib/optimise/origin.d.mts +11 -0
  179. package/lib/optimise/scale.d.cts +11 -0
  180. package/lib/optimise/scale.d.mts +11 -0
  181. package/lib/optimise/svgo.d.cts +37 -0
  182. package/lib/optimise/svgo.d.mts +37 -0
  183. package/lib/svg/analyse/error.d.cts +10 -0
  184. package/lib/svg/analyse/error.d.mts +10 -0
  185. package/lib/svg/analyse/types.d.cts +92 -0
  186. package/lib/svg/analyse/types.d.mts +92 -0
  187. package/lib/svg/analyse/types.d.ts +1 -1
  188. package/lib/svg/analyse.d.cts +15 -0
  189. package/lib/svg/analyse.d.mts +15 -0
  190. package/lib/svg/cleanup/attribs.d.cts +11 -0
  191. package/lib/svg/cleanup/attribs.d.mts +11 -0
  192. package/lib/svg/cleanup/bad-tags.d.cts +17 -0
  193. package/lib/svg/cleanup/bad-tags.d.mts +17 -0
  194. package/lib/svg/cleanup/bad-tags.d.ts +1 -1
  195. package/lib/svg/cleanup/inline-style.d.cts +11 -0
  196. package/lib/svg/cleanup/inline-style.d.mts +11 -0
  197. package/lib/svg/cleanup/root-style.d.cts +17 -0
  198. package/lib/svg/cleanup/root-style.d.mts +17 -0
  199. package/lib/svg/cleanup/root-svg.d.cts +11 -0
  200. package/lib/svg/cleanup/root-svg.d.mts +11 -0
  201. package/lib/svg/cleanup/svgo-style.d.cts +11 -0
  202. package/lib/svg/cleanup/svgo-style.d.mts +11 -0
  203. package/lib/svg/cleanup.d.cts +16 -0
  204. package/lib/svg/cleanup.d.mts +16 -0
  205. package/lib/svg/cleanup.d.ts +1 -1
  206. package/lib/svg/data/attributes.d.cts +77 -0
  207. package/lib/svg/data/attributes.d.mts +77 -0
  208. package/lib/svg/data/tags.d.cts +95 -0
  209. package/lib/svg/data/tags.d.mts +95 -0
  210. package/lib/svg/index.cjs +17 -0
  211. package/lib/svg/index.d.cts +52 -0
  212. package/lib/svg/index.d.mts +52 -0
  213. package/lib/svg/index.d.ts +5 -1
  214. package/lib/svg/index.mjs +18 -1
  215. package/lib/svg/parse-style.d.cts +58 -0
  216. package/lib/svg/parse-style.d.mts +58 -0
  217. package/lib/svg/parse-style.d.ts +1 -1
  218. package/lib/svg/parse.d.cts +30 -0
  219. package/lib/svg/parse.d.mts +30 -0
  220. package/lib/svg/parse.d.ts +1 -1
  221. package/package.json +14 -17
@@ -0,0 +1,8 @@
1
+ import { APIQueryParams } from './types.mjs';
2
+
3
+ /**
4
+ * Download file
5
+ */
6
+ declare function downloadFile(query: APIQueryParams, target: string): Promise<void>;
7
+
8
+ export { downloadFile };
@@ -0,0 +1,8 @@
1
+ import { APIQueryParams, APICacheOptions } from './types.cjs';
2
+
3
+ /**
4
+ * Send API query
5
+ */
6
+ declare function sendAPIQuery(query: APIQueryParams, cache?: APICacheOptions): Promise<number | string>;
7
+
8
+ export { sendAPIQuery };
@@ -0,0 +1,8 @@
1
+ import { APIQueryParams, APICacheOptions } from './types.mjs';
2
+
3
+ /**
4
+ * Send API query
5
+ */
6
+ declare function sendAPIQuery(query: APIQueryParams, cache?: APICacheOptions): Promise<number | string>;
7
+
8
+ export { sendAPIQuery };
@@ -0,0 +1,32 @@
1
+ /**
2
+ * Default parameters
3
+ */
4
+ declare const defaultQueueParams: ConcurrentQueriesCommonParams<unknown>;
5
+ /**
6
+ * Callback to get query
7
+ */
8
+ type GetConcurrentQueryCallback<T> = (index: number) => Promise<T>;
9
+ /**
10
+ * Parameters
11
+ */
12
+ interface ConcurrentQueriesCommonParams<T> {
13
+ limit?: number;
14
+ retries?: number;
15
+ onError?: (index: number, error: unknown, params: ConcurrentQueriesParams<T>) => void | Promise<void>;
16
+ onSuccess?: (index: number, params: ConcurrentQueriesParams<T>, result: T) => void;
17
+ onStart?: (index: number, params: ConcurrentQueriesParams<T>) => void;
18
+ }
19
+ interface ConcurrentQueriesParamsWithCount<T> extends ConcurrentQueriesCommonParams<T> {
20
+ total: number;
21
+ callback: (index: number) => Promise<T>;
22
+ }
23
+ interface ConcurrentQueriesParamsWithPromises<T> extends ConcurrentQueriesCommonParams<T> {
24
+ promises: Promise<T>[];
25
+ }
26
+ type ConcurrentQueriesParams<T> = ConcurrentQueriesParamsWithCount<T> | ConcurrentQueriesParamsWithPromises<T>;
27
+ /**
28
+ * Runs concurrent async operations
29
+ */
30
+ declare function runConcurrentQueries<T>(params: ConcurrentQueriesParams<T>): Promise<T[]>;
31
+
32
+ export { type ConcurrentQueriesCommonParams, type ConcurrentQueriesParams, type ConcurrentQueriesParamsWithCount, type ConcurrentQueriesParamsWithPromises, type GetConcurrentQueryCallback, defaultQueueParams, runConcurrentQueries };
@@ -0,0 +1,32 @@
1
+ /**
2
+ * Default parameters
3
+ */
4
+ declare const defaultQueueParams: ConcurrentQueriesCommonParams<unknown>;
5
+ /**
6
+ * Callback to get query
7
+ */
8
+ type GetConcurrentQueryCallback<T> = (index: number) => Promise<T>;
9
+ /**
10
+ * Parameters
11
+ */
12
+ interface ConcurrentQueriesCommonParams<T> {
13
+ limit?: number;
14
+ retries?: number;
15
+ onError?: (index: number, error: unknown, params: ConcurrentQueriesParams<T>) => void | Promise<void>;
16
+ onSuccess?: (index: number, params: ConcurrentQueriesParams<T>, result: T) => void;
17
+ onStart?: (index: number, params: ConcurrentQueriesParams<T>) => void;
18
+ }
19
+ interface ConcurrentQueriesParamsWithCount<T> extends ConcurrentQueriesCommonParams<T> {
20
+ total: number;
21
+ callback: (index: number) => Promise<T>;
22
+ }
23
+ interface ConcurrentQueriesParamsWithPromises<T> extends ConcurrentQueriesCommonParams<T> {
24
+ promises: Promise<T>[];
25
+ }
26
+ type ConcurrentQueriesParams<T> = ConcurrentQueriesParamsWithCount<T> | ConcurrentQueriesParamsWithPromises<T>;
27
+ /**
28
+ * Runs concurrent async operations
29
+ */
30
+ declare function runConcurrentQueries<T>(params: ConcurrentQueriesParams<T>): Promise<T[]>;
31
+
32
+ export { type ConcurrentQueriesCommonParams, type ConcurrentQueriesParams, type ConcurrentQueriesParamsWithCount, type ConcurrentQueriesParamsWithPromises, type GetConcurrentQueryCallback, defaultQueueParams, runConcurrentQueries };
@@ -29,4 +29,4 @@ type ConcurrentQueriesParams<T> = ConcurrentQueriesParamsWithCount<T> | Concurre
29
29
  */
30
30
  declare function runConcurrentQueries<T>(params: ConcurrentQueriesParams<T>): Promise<T[]>;
31
31
 
32
- export { ConcurrentQueriesCommonParams, ConcurrentQueriesParams, ConcurrentQueriesParamsWithCount, ConcurrentQueriesParamsWithPromises, GetConcurrentQueryCallback, defaultQueueParams, runConcurrentQueries };
32
+ export { type ConcurrentQueriesCommonParams, type ConcurrentQueriesParams, type ConcurrentQueriesParamsWithCount, type ConcurrentQueriesParamsWithPromises, type GetConcurrentQueryCallback, defaultQueueParams, runConcurrentQueries };
@@ -0,0 +1,17 @@
1
+ /**
2
+ * API Cache
3
+ */
4
+ interface APICacheOptions {
5
+ dir: string;
6
+ ttl: number;
7
+ }
8
+ /**
9
+ * Params
10
+ */
11
+ interface APIQueryParams {
12
+ uri: string;
13
+ params?: URLSearchParams;
14
+ headers?: Record<string, string>;
15
+ }
16
+
17
+ export type { APICacheOptions, APIQueryParams };
@@ -0,0 +1,17 @@
1
+ /**
2
+ * API Cache
3
+ */
4
+ interface APICacheOptions {
5
+ dir: string;
6
+ ttl: number;
7
+ }
8
+ /**
9
+ * Params
10
+ */
11
+ interface APIQueryParams {
12
+ uri: string;
13
+ params?: URLSearchParams;
14
+ headers?: Record<string, string>;
15
+ }
16
+
17
+ export type { APICacheOptions, APIQueryParams };
@@ -14,4 +14,4 @@ interface APIQueryParams {
14
14
  headers?: Record<string, string>;
15
15
  }
16
16
 
17
- export { APICacheOptions, APIQueryParams };
17
+ export type { APICacheOptions, APIQueryParams };
@@ -0,0 +1,8 @@
1
+ import { ExportTargetOptions } from '../../export/helpers/prepare.cjs';
2
+
3
+ /**
4
+ * Get current branch from cloned git repo
5
+ */
6
+ declare function getGitRepoBranch(options: ExportTargetOptions, checkout?: string): Promise<string>;
7
+
8
+ export { getGitRepoBranch };
@@ -0,0 +1,8 @@
1
+ import { ExportTargetOptions } from '../../export/helpers/prepare.mjs';
2
+
3
+ /**
4
+ * Get current branch from cloned git repo
5
+ */
6
+ declare function getGitRepoBranch(options: ExportTargetOptions, checkout?: string): Promise<string>;
7
+
8
+ export { getGitRepoBranch };
@@ -0,0 +1,8 @@
1
+ import { ExportTargetOptions } from '../../export/helpers/prepare.cjs';
2
+
3
+ /**
4
+ * Get latest hash from cloned git repo
5
+ */
6
+ declare function getGitRepoHash(options: ExportTargetOptions): Promise<string>;
7
+
8
+ export { getGitRepoHash };
@@ -0,0 +1,8 @@
1
+ import { ExportTargetOptions } from '../../export/helpers/prepare.mjs';
2
+
3
+ /**
4
+ * Get latest hash from cloned git repo
5
+ */
6
+ declare function getGitRepoHash(options: ExportTargetOptions): Promise<string>;
7
+
8
+ export { getGitRepoHash };
@@ -0,0 +1,29 @@
1
+ import { ExportTargetOptions } from '../../export/helpers/prepare.cjs';
2
+ import { DocumentNotModified } from '../types/modified.cjs';
3
+ import { DownloadSourceMixin } from '../types/sources.cjs';
4
+
5
+ interface IfModifiedSinceOption {
6
+ ifModifiedSince: string | true | DownloadGitRepoResult;
7
+ }
8
+ /**
9
+ * Options for downloadGitRepo()
10
+ */
11
+ interface DownloadGitRepoOptions extends ExportTargetOptions, Partial<IfModifiedSinceOption> {
12
+ remote: string;
13
+ branch: string;
14
+ log?: boolean;
15
+ }
16
+ /**
17
+ * Result
18
+ */
19
+ interface DownloadGitRepoResult extends DownloadSourceMixin<'git'> {
20
+ contentsDir: string;
21
+ hash: string;
22
+ }
23
+ /**
24
+ * Download Git repo
25
+ */
26
+ declare function downloadGitRepo<T extends IfModifiedSinceOption & DownloadGitRepoOptions>(options: T): Promise<DownloadGitRepoResult | DocumentNotModified>;
27
+ declare function downloadGitRepo(options: DownloadGitRepoOptions): Promise<DownloadGitRepoResult>;
28
+
29
+ export { type DownloadGitRepoOptions, type DownloadGitRepoResult, downloadGitRepo };
@@ -0,0 +1,29 @@
1
+ import { ExportTargetOptions } from '../../export/helpers/prepare.mjs';
2
+ import { DocumentNotModified } from '../types/modified.mjs';
3
+ import { DownloadSourceMixin } from '../types/sources.mjs';
4
+
5
+ interface IfModifiedSinceOption {
6
+ ifModifiedSince: string | true | DownloadGitRepoResult;
7
+ }
8
+ /**
9
+ * Options for downloadGitRepo()
10
+ */
11
+ interface DownloadGitRepoOptions extends ExportTargetOptions, Partial<IfModifiedSinceOption> {
12
+ remote: string;
13
+ branch: string;
14
+ log?: boolean;
15
+ }
16
+ /**
17
+ * Result
18
+ */
19
+ interface DownloadGitRepoResult extends DownloadSourceMixin<'git'> {
20
+ contentsDir: string;
21
+ hash: string;
22
+ }
23
+ /**
24
+ * Download Git repo
25
+ */
26
+ declare function downloadGitRepo<T extends IfModifiedSinceOption & DownloadGitRepoOptions>(options: T): Promise<DownloadGitRepoResult | DocumentNotModified>;
27
+ declare function downloadGitRepo(options: DownloadGitRepoOptions): Promise<DownloadGitRepoResult>;
28
+
29
+ export { type DownloadGitRepoOptions, type DownloadGitRepoResult, downloadGitRepo };
@@ -26,4 +26,4 @@ interface DownloadGitRepoResult extends DownloadSourceMixin<'git'> {
26
26
  declare function downloadGitRepo<T extends IfModifiedSinceOption & DownloadGitRepoOptions>(options: T): Promise<DownloadGitRepoResult | DocumentNotModified>;
27
27
  declare function downloadGitRepo(options: DownloadGitRepoOptions): Promise<DownloadGitRepoResult>;
28
28
 
29
- export { DownloadGitRepoOptions, DownloadGitRepoResult, downloadGitRepo };
29
+ export { type DownloadGitRepoOptions, type DownloadGitRepoResult, downloadGitRepo };
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Reset Git repo contents
3
+ */
4
+ declare function resetGitRepoContents(target: string): Promise<void>;
5
+
6
+ export { resetGitRepoContents };
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Reset Git repo contents
3
+ */
4
+ declare function resetGitRepoContents(target: string): Promise<void>;
5
+
6
+ export { resetGitRepoContents };
@@ -0,0 +1,8 @@
1
+ import { GitHubAPIOptions } from './types.cjs';
2
+
3
+ /**
4
+ * Get latest hash from GitHub using API
5
+ */
6
+ declare function getGitHubRepoHash(options: GitHubAPIOptions): Promise<string>;
7
+
8
+ export { getGitHubRepoHash };
@@ -0,0 +1,8 @@
1
+ import { GitHubAPIOptions } from './types.mjs';
2
+
3
+ /**
4
+ * Get latest hash from GitHub using API
5
+ */
6
+ declare function getGitHubRepoHash(options: GitHubAPIOptions): Promise<string>;
7
+
8
+ export { getGitHubRepoHash };
@@ -0,0 +1,31 @@
1
+ import { ExportTargetOptions } from '../../export/helpers/prepare.cjs';
2
+ import { DocumentNotModified } from '../types/modified.cjs';
3
+ import { GitHubAPIOptions } from './types.cjs';
4
+ import { DownloadSourceMixin } from '../types/sources.cjs';
5
+
6
+ interface IfModifiedSinceOption {
7
+ ifModifiedSince: string | DownloadGitHubRepoResult;
8
+ }
9
+ /**
10
+ * Options for downloadGitHubRepo()
11
+ */
12
+ interface DownloadGitHubRepoOptions extends ExportTargetOptions, GitHubAPIOptions, Partial<IfModifiedSinceOption> {
13
+ cleanupOldFiles?: boolean;
14
+ cleanupOldDirectories?: boolean;
15
+ log?: boolean;
16
+ }
17
+ /**
18
+ * Result
19
+ */
20
+ interface DownloadGitHubRepoResult extends DownloadSourceMixin<'github'> {
21
+ rootDir: string;
22
+ contentsDir: string;
23
+ hash: string;
24
+ }
25
+ /**
26
+ * Download GitHub repo using API
27
+ */
28
+ declare function downloadGitHubRepo<T extends IfModifiedSinceOption & DownloadGitHubRepoOptions>(options: T): Promise<DownloadGitHubRepoResult | DocumentNotModified>;
29
+ declare function downloadGitHubRepo(options: DownloadGitHubRepoOptions): Promise<DownloadGitHubRepoResult>;
30
+
31
+ export { type DownloadGitHubRepoOptions, type DownloadGitHubRepoResult, downloadGitHubRepo };
@@ -0,0 +1,31 @@
1
+ import { ExportTargetOptions } from '../../export/helpers/prepare.mjs';
2
+ import { DocumentNotModified } from '../types/modified.mjs';
3
+ import { GitHubAPIOptions } from './types.mjs';
4
+ import { DownloadSourceMixin } from '../types/sources.mjs';
5
+
6
+ interface IfModifiedSinceOption {
7
+ ifModifiedSince: string | DownloadGitHubRepoResult;
8
+ }
9
+ /**
10
+ * Options for downloadGitHubRepo()
11
+ */
12
+ interface DownloadGitHubRepoOptions extends ExportTargetOptions, GitHubAPIOptions, Partial<IfModifiedSinceOption> {
13
+ cleanupOldFiles?: boolean;
14
+ cleanupOldDirectories?: boolean;
15
+ log?: boolean;
16
+ }
17
+ /**
18
+ * Result
19
+ */
20
+ interface DownloadGitHubRepoResult extends DownloadSourceMixin<'github'> {
21
+ rootDir: string;
22
+ contentsDir: string;
23
+ hash: string;
24
+ }
25
+ /**
26
+ * Download GitHub repo using API
27
+ */
28
+ declare function downloadGitHubRepo<T extends IfModifiedSinceOption & DownloadGitHubRepoOptions>(options: T): Promise<DownloadGitHubRepoResult | DocumentNotModified>;
29
+ declare function downloadGitHubRepo(options: DownloadGitHubRepoOptions): Promise<DownloadGitHubRepoResult>;
30
+
31
+ export { type DownloadGitHubRepoOptions, type DownloadGitHubRepoResult, downloadGitHubRepo };
@@ -28,4 +28,4 @@ interface DownloadGitHubRepoResult extends DownloadSourceMixin<'github'> {
28
28
  declare function downloadGitHubRepo<T extends IfModifiedSinceOption & DownloadGitHubRepoOptions>(options: T): Promise<DownloadGitHubRepoResult | DocumentNotModified>;
29
29
  declare function downloadGitHubRepo(options: DownloadGitHubRepoOptions): Promise<DownloadGitHubRepoResult>;
30
30
 
31
- export { DownloadGitHubRepoOptions, DownloadGitHubRepoResult, downloadGitHubRepo };
31
+ export { type DownloadGitHubRepoOptions, type DownloadGitHubRepoResult, downloadGitHubRepo };
@@ -0,0 +1,11 @@
1
+ /**
2
+ * API options
3
+ */
4
+ interface GitHubAPIOptions {
5
+ token: string;
6
+ user: string;
7
+ repo: string;
8
+ branch: string;
9
+ }
10
+
11
+ export type { GitHubAPIOptions };
@@ -0,0 +1,11 @@
1
+ /**
2
+ * API options
3
+ */
4
+ interface GitHubAPIOptions {
5
+ token: string;
6
+ user: string;
7
+ repo: string;
8
+ branch: string;
9
+ }
10
+
11
+ export type { GitHubAPIOptions };
@@ -8,4 +8,4 @@ interface GitHubAPIOptions {
8
8
  branch: string;
9
9
  }
10
10
 
11
- export { GitHubAPIOptions };
11
+ export type { GitHubAPIOptions };
@@ -0,0 +1,8 @@
1
+ import { GitLabAPIOptions } from './types.cjs';
2
+
3
+ /**
4
+ * Get latest hash from GitHub using API
5
+ */
6
+ declare function getGitLabRepoHash(options: GitLabAPIOptions): Promise<string>;
7
+
8
+ export { getGitLabRepoHash };
@@ -0,0 +1,8 @@
1
+ import { GitLabAPIOptions } from './types.mjs';
2
+
3
+ /**
4
+ * Get latest hash from GitHub using API
5
+ */
6
+ declare function getGitLabRepoHash(options: GitLabAPIOptions): Promise<string>;
7
+
8
+ export { getGitLabRepoHash };
@@ -0,0 +1,31 @@
1
+ import { ExportTargetOptions } from '../../export/helpers/prepare.cjs';
2
+ import { DocumentNotModified } from '../types/modified.cjs';
3
+ import { GitLabAPIOptions } from './types.cjs';
4
+ import { DownloadSourceMixin } from '../types/sources.cjs';
5
+
6
+ interface IfModifiedSinceOption {
7
+ ifModifiedSince: string | DownloadGitLabRepoResult;
8
+ }
9
+ /**
10
+ * Options for downloadGitLabRepo()
11
+ */
12
+ interface DownloadGitLabRepoOptions extends ExportTargetOptions, GitLabAPIOptions, Partial<IfModifiedSinceOption> {
13
+ cleanupOldFiles?: boolean;
14
+ cleanupOldDirectories?: boolean;
15
+ log?: boolean;
16
+ }
17
+ /**
18
+ * Result
19
+ */
20
+ interface DownloadGitLabRepoResult extends DownloadSourceMixin<'gitlab'> {
21
+ rootDir: string;
22
+ contentsDir: string;
23
+ hash: string;
24
+ }
25
+ /**
26
+ * Download GitLab repo using API
27
+ */
28
+ declare function downloadGitLabRepo<T extends IfModifiedSinceOption & DownloadGitLabRepoOptions>(options: T): Promise<DownloadGitLabRepoResult | DocumentNotModified>;
29
+ declare function downloadGitLabRepo(options: DownloadGitLabRepoOptions): Promise<DownloadGitLabRepoResult>;
30
+
31
+ export { type DownloadGitLabRepoOptions, type DownloadGitLabRepoResult, downloadGitLabRepo };
@@ -0,0 +1,31 @@
1
+ import { ExportTargetOptions } from '../../export/helpers/prepare.mjs';
2
+ import { DocumentNotModified } from '../types/modified.mjs';
3
+ import { GitLabAPIOptions } from './types.mjs';
4
+ import { DownloadSourceMixin } from '../types/sources.mjs';
5
+
6
+ interface IfModifiedSinceOption {
7
+ ifModifiedSince: string | DownloadGitLabRepoResult;
8
+ }
9
+ /**
10
+ * Options for downloadGitLabRepo()
11
+ */
12
+ interface DownloadGitLabRepoOptions extends ExportTargetOptions, GitLabAPIOptions, Partial<IfModifiedSinceOption> {
13
+ cleanupOldFiles?: boolean;
14
+ cleanupOldDirectories?: boolean;
15
+ log?: boolean;
16
+ }
17
+ /**
18
+ * Result
19
+ */
20
+ interface DownloadGitLabRepoResult extends DownloadSourceMixin<'gitlab'> {
21
+ rootDir: string;
22
+ contentsDir: string;
23
+ hash: string;
24
+ }
25
+ /**
26
+ * Download GitLab repo using API
27
+ */
28
+ declare function downloadGitLabRepo<T extends IfModifiedSinceOption & DownloadGitLabRepoOptions>(options: T): Promise<DownloadGitLabRepoResult | DocumentNotModified>;
29
+ declare function downloadGitLabRepo(options: DownloadGitLabRepoOptions): Promise<DownloadGitLabRepoResult>;
30
+
31
+ export { type DownloadGitLabRepoOptions, type DownloadGitLabRepoResult, downloadGitLabRepo };
@@ -28,4 +28,4 @@ interface DownloadGitLabRepoResult extends DownloadSourceMixin<'gitlab'> {
28
28
  declare function downloadGitLabRepo<T extends IfModifiedSinceOption & DownloadGitLabRepoOptions>(options: T): Promise<DownloadGitLabRepoResult | DocumentNotModified>;
29
29
  declare function downloadGitLabRepo(options: DownloadGitLabRepoOptions): Promise<DownloadGitLabRepoResult>;
30
30
 
31
- export { DownloadGitLabRepoOptions, DownloadGitLabRepoResult, downloadGitLabRepo };
31
+ export { type DownloadGitLabRepoOptions, type DownloadGitLabRepoResult, downloadGitLabRepo };
@@ -0,0 +1,15 @@
1
+ /**
2
+ * API options
3
+ */
4
+ interface GitLabAPIOptions {
5
+ uri?: string;
6
+ token: string;
7
+ project: string;
8
+ branch: string;
9
+ }
10
+ /**
11
+ * Default base URI for GitLab API
12
+ */
13
+ declare const defaultGitLabBaseURI = "https://gitlab.com/api/v4/projects";
14
+
15
+ export { type GitLabAPIOptions, defaultGitLabBaseURI };
@@ -0,0 +1,15 @@
1
+ /**
2
+ * API options
3
+ */
4
+ interface GitLabAPIOptions {
5
+ uri?: string;
6
+ token: string;
7
+ project: string;
8
+ branch: string;
9
+ }
10
+ /**
11
+ * Default base URI for GitLab API
12
+ */
13
+ declare const defaultGitLabBaseURI = "https://gitlab.com/api/v4/projects";
14
+
15
+ export { type GitLabAPIOptions, defaultGitLabBaseURI };
@@ -12,4 +12,4 @@ interface GitLabAPIOptions {
12
12
  */
13
13
  declare const defaultGitLabBaseURI = "https://gitlab.com/api/v4/projects";
14
14
 
15
- export { GitLabAPIOptions, defaultGitLabBaseURI };
15
+ export { type GitLabAPIOptions, defaultGitLabBaseURI };
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Unpack .tgz archive
3
+ */
4
+ declare function untar(file: string, path: string): Promise<void>;
5
+
6
+ export { untar };
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Unpack .tgz archive
3
+ */
4
+ declare function untar(file: string, path: string): Promise<void>;
5
+
6
+ export { untar };
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Unzip archive
3
+ */
4
+ declare function unzip(source: string, path: string): Promise<void>;
5
+
6
+ export { unzip };
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Unzip archive
3
+ */
4
+ declare function unzip(source: string, path: string): Promise<void>;
5
+
6
+ export { unzip };
@@ -0,0 +1,48 @@
1
+ import { DownloadGitHubRepoOptions, DownloadGitHubRepoResult } from './github/index.cjs';
2
+ import { DownloadGitRepoOptions, DownloadGitRepoResult } from './git/index.cjs';
3
+ import { DownloadNPMPackageOptions, DownloadNPMPackageResult } from './npm/index.cjs';
4
+ import { DocumentNotModified } from './types/modified.cjs';
5
+ import { DownloadSourceType, DownloadSourceMixin } from './types/sources.cjs';
6
+ import { DownloadGitLabRepoOptions, DownloadGitLabRepoResult } from './gitlab/index.cjs';
7
+ import '../export/helpers/prepare.cjs';
8
+ import './github/types.cjs';
9
+ import './gitlab/types.cjs';
10
+
11
+ /**
12
+ * Options and result combinations
13
+ */
14
+ interface DownloadGitRepo {
15
+ options: DownloadGitRepoOptions & DownloadSourceMixin<'git'>;
16
+ result: DownloadGitRepoResult;
17
+ }
18
+ interface DownloadGitHubRepo {
19
+ options: DownloadGitHubRepoOptions & DownloadSourceMixin<'github'>;
20
+ result: DownloadGitHubRepoResult;
21
+ }
22
+ interface DownloadGitLabRepo {
23
+ options: DownloadGitLabRepoOptions & DownloadSourceMixin<'gitlab'>;
24
+ result: DownloadGitLabRepoResult;
25
+ }
26
+ interface DownloadNPMPackage {
27
+ options: DownloadNPMPackageOptions & DownloadSourceMixin<'npm'>;
28
+ result: DownloadNPMPackageResult;
29
+ }
30
+ /**
31
+ * Combinations based on type
32
+ */
33
+ type DownloadParamsMixin<T extends DownloadSourceType> = T extends 'git' ? DownloadGitRepo : T extends 'github' ? DownloadGitHubRepo : T extends 'gitlab' ? DownloadGitLabRepo : T extends 'npm' ? DownloadNPMPackage : never;
34
+ /**
35
+ * Combinations
36
+ */
37
+ type DownloadParams = DownloadGitRepo | DownloadGitHubRepo | DownloadGitLabRepo | DownloadNPMPackage;
38
+ /**
39
+ * Pick options or result from combinations
40
+ */
41
+ type DownloadOptions<T extends DownloadSourceType> = DownloadParamsMixin<T>['options'];
42
+ type DownloadResult<T extends DownloadSourceType> = Promise<DocumentNotModified | DownloadParamsMixin<T>['result']>;
43
+ declare function downloadPackage<T extends 'git'>(options: DownloadOptions<T>): DownloadResult<T>;
44
+ declare function downloadPackage<T extends 'github'>(options: DownloadOptions<T>): DownloadResult<T>;
45
+ declare function downloadPackage<T extends 'gitlab'>(options: DownloadOptions<T>): DownloadResult<T>;
46
+ declare function downloadPackage<T extends 'npm'>(options: DownloadOptions<T>): DownloadResult<T>;
47
+
48
+ export { type DownloadParams, type DownloadParamsMixin, downloadPackage };