@immich/sdk 1.138.0 → 2.1.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.
package/.nvmrc CHANGED
@@ -1 +1 @@
1
- 22.18.0
1
+ 22.20.0
package/LICENSE ADDED
@@ -0,0 +1,620 @@
1
+ GNU AFFERO GENERAL PUBLIC LICENSE
2
+ Version 3, 19 November 2007
3
+
4
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5
+ Everyone is permitted to copy and distribute verbatim copies
6
+ of this license document, but changing it is not allowed.
7
+
8
+ Preamble
9
+
10
+ The GNU Affero General Public License is a free, copyleft license for
11
+ software and other kinds of works, specifically designed to ensure
12
+ cooperation with the community in the case of network server software.
13
+
14
+ The licenses for most software and other practical works are designed
15
+ to take away your freedom to share and change the works. By contrast,
16
+ our General Public Licenses are intended to guarantee your freedom to
17
+ share and change all versions of a program--to make sure it remains free
18
+ software for all its users.
19
+
20
+ When we speak of free software, we are referring to freedom, not
21
+ price. Our General Public Licenses are designed to make sure that you
22
+ have the freedom to distribute copies of free software (and charge for
23
+ them if you wish), that you receive source code or can get it if you
24
+ want it, that you can change the software or use pieces of it in new
25
+ free programs, and that you know you can do these things.
26
+
27
+ Developers that use our General Public Licenses protect your rights
28
+ with two steps: (1) assert copyright on the software, and (2) offer
29
+ you this License which gives you legal permission to copy, distribute
30
+ and/or modify the software.
31
+
32
+ A secondary benefit of defending all users' freedom is that
33
+ improvements made in alternate versions of the program, if they
34
+ receive widespread use, become available for other developers to
35
+ incorporate. Many developers of free software are heartened and
36
+ encouraged by the resulting cooperation. However, in the case of
37
+ software used on network servers, this result may fail to come about.
38
+ The GNU General Public License permits making a modified version and
39
+ letting the public access it on a server without ever releasing its
40
+ source code to the public.
41
+
42
+ The GNU Affero General Public License is designed specifically to
43
+ ensure that, in such cases, the modified source code becomes available
44
+ to the community. It requires the operator of a network server to
45
+ provide the source code of the modified version running there to the
46
+ users of that server. Therefore, public use of a modified version, on
47
+ a publicly accessible server, gives the public access to the source
48
+ code of the modified version.
49
+
50
+ An older license, called the Affero General Public License and
51
+ published by Affero, was designed to accomplish similar goals. This is
52
+ a different license, not a version of the Affero GPL, but Affero has
53
+ released a new version of the Affero GPL which permits relicensing under
54
+ this license.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ TERMS AND CONDITIONS
60
+
61
+ 0. Definitions.
62
+
63
+ "This License" refers to version 3 of the GNU Affero General Public License.
64
+
65
+ "Copyright" also means copyright-like laws that apply to other kinds of
66
+ works, such as semiconductor masks.
67
+
68
+ "The Program" refers to any copyrightable work licensed under this
69
+ License. Each licensee is addressed as "you". "Licensees" and
70
+ "recipients" may be individuals or organizations.
71
+
72
+ To "modify" a work means to copy from or adapt all or part of the work
73
+ in a fashion requiring copyright permission, other than the making of an
74
+ exact copy. The resulting work is called a "modified version" of the
75
+ earlier work or a work "based on" the earlier work.
76
+
77
+ A "covered work" means either the unmodified Program or a work based
78
+ on the Program.
79
+
80
+ To "propagate" a work means to do anything with it that, without
81
+ permission, would make you directly or secondarily liable for
82
+ infringement under applicable copyright law, except executing it on a
83
+ computer or modifying a private copy. Propagation includes copying,
84
+ distribution (with or without modification), making available to the
85
+ public, and in some countries other activities as well.
86
+
87
+ To "convey" a work means any kind of propagation that enables other
88
+ parties to make or receive copies. Mere interaction with a user through
89
+ a computer network, with no transfer of a copy, is not conveying.
90
+
91
+ An interactive user interface displays "Appropriate Legal Notices"
92
+ to the extent that it includes a convenient and prominently visible
93
+ feature that (1) displays an appropriate copyright notice, and (2)
94
+ tells the user that there is no warranty for the work (except to the
95
+ extent that warranties are provided), that licensees may convey the
96
+ work under this License, and how to view a copy of this License. If
97
+ the interface presents a list of user commands or options, such as a
98
+ menu, a prominent item in the list meets this criterion.
99
+
100
+ 1. Source Code.
101
+
102
+ The "source code" for a work means the preferred form of the work
103
+ for making modifications to it. "Object code" means any non-source
104
+ form of a work.
105
+
106
+ A "Standard Interface" means an interface that either is an official
107
+ standard defined by a recognized standards body, or, in the case of
108
+ interfaces specified for a particular programming language, one that
109
+ is widely used among developers working in that language.
110
+
111
+ The "System Libraries" of an executable work include anything, other
112
+ than the work as a whole, that (a) is included in the normal form of
113
+ packaging a Major Component, but which is not part of that Major
114
+ Component, and (b) serves only to enable use of the work with that
115
+ Major Component, or to implement a Standard Interface for which an
116
+ implementation is available to the public in source code form. A
117
+ "Major Component", in this context, means a major essential component
118
+ (kernel, window system, and so on) of the specific operating system
119
+ (if any) on which the executable work runs, or a compiler used to
120
+ produce the work, or an object code interpreter used to run it.
121
+
122
+ The "Corresponding Source" for a work in object code form means all
123
+ the source code needed to generate, install, and (for an executable
124
+ work) run the object code and to modify the work, including scripts to
125
+ control those activities. However, it does not include the work's
126
+ System Libraries, or general-purpose tools or generally available free
127
+ programs which are used unmodified in performing those activities but
128
+ which are not part of the work. For example, Corresponding Source
129
+ includes interface definition files associated with source files for
130
+ the work, and the source code for shared libraries and dynamically
131
+ linked subprograms that the work is specifically designed to require,
132
+ such as by intimate data communication or control flow between those
133
+ subprograms and other parts of the work.
134
+
135
+ The Corresponding Source need not include anything that users
136
+ can regenerate automatically from other parts of the Corresponding
137
+ Source.
138
+
139
+ The Corresponding Source for a work in source code form is that
140
+ same work.
141
+
142
+ 2. Basic Permissions.
143
+
144
+ All rights granted under this License are granted for the term of
145
+ copyright on the Program, and are irrevocable provided the stated
146
+ conditions are met. This License explicitly affirms your unlimited
147
+ permission to run the unmodified Program. The output from running a
148
+ covered work is covered by this License only if the output, given its
149
+ content, constitutes a covered work. This License acknowledges your
150
+ rights of fair use or other equivalent, as provided by copyright law.
151
+
152
+ You may make, run and propagate covered works that you do not
153
+ convey, without conditions so long as your license otherwise remains
154
+ in force. You may convey covered works to others for the sole purpose
155
+ of having them make modifications exclusively for you, or provide you
156
+ with facilities for running those works, provided that you comply with
157
+ the terms of this License in conveying all material for which you do
158
+ not control copyright. Those thus making or running the covered works
159
+ for you must do so exclusively on your behalf, under your direction
160
+ and control, on terms that prohibit them from making any copies of
161
+ your copyrighted material outside their relationship with you.
162
+
163
+ Conveying under any other circumstances is permitted solely under
164
+ the conditions stated below. Sublicensing is not allowed; section 10
165
+ makes it unnecessary.
166
+
167
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
168
+
169
+ No covered work shall be deemed part of an effective technological
170
+ measure under any applicable law fulfilling obligations under article
171
+ 11 of the WIPO copyright treaty adopted on 20 December 1996, or
172
+ similar laws prohibiting or restricting circumvention of such
173
+ measures.
174
+
175
+ When you convey a covered work, you waive any legal power to forbid
176
+ circumvention of technological measures to the extent such circumvention
177
+ is effected by exercising rights under this License with respect to
178
+ the covered work, and you disclaim any intention to limit operation or
179
+ modification of the work as a means of enforcing, against the work's
180
+ users, your or third parties' legal rights to forbid circumvention of
181
+ technological measures.
182
+
183
+ 4. Conveying Verbatim Copies.
184
+
185
+ You may convey verbatim copies of the Program's source code as you
186
+ receive it, in any medium, provided that you conspicuously and
187
+ appropriately publish on each copy an appropriate copyright notice;
188
+ keep intact all notices stating that this License and any
189
+ non-permissive terms added in accord with section 7 apply to the code;
190
+ keep intact all notices of the absence of any warranty; and give all
191
+ recipients a copy of this License along with the Program.
192
+
193
+ You may charge any price or no price for each copy that you convey,
194
+ and you may offer support or warranty protection for a fee.
195
+
196
+ 5. Conveying Modified Source Versions.
197
+
198
+ You may convey a work based on the Program, or the modifications to
199
+ produce it from the Program, in the form of source code under the
200
+ terms of section 4, provided that you also meet all of these conditions:
201
+
202
+ a) The work must carry prominent notices stating that you modified
203
+ it, and giving a relevant date.
204
+
205
+ b) The work must carry prominent notices stating that it is
206
+ released under this License and any conditions added under section
207
+ 7. This requirement modifies the requirement in section 4 to
208
+ "keep intact all notices".
209
+
210
+ c) You must license the entire work, as a whole, under this
211
+ License to anyone who comes into possession of a copy. This
212
+ License will therefore apply, along with any applicable section 7
213
+ additional terms, to the whole of the work, and all its parts,
214
+ regardless of how they are packaged. This License gives no
215
+ permission to license the work in any other way, but it does not
216
+ invalidate such permission if you have separately received it.
217
+
218
+ d) If the work has interactive user interfaces, each must display
219
+ Appropriate Legal Notices; however, if the Program has interactive
220
+ interfaces that do not display Appropriate Legal Notices, your
221
+ work need not make them do so.
222
+
223
+ A compilation of a covered work with other separate and independent
224
+ works, which are not by their nature extensions of the covered work,
225
+ and which are not combined with it such as to form a larger program,
226
+ in or on a volume of a storage or distribution medium, is called an
227
+ "aggregate" if the compilation and its resulting copyright are not
228
+ used to limit the access or legal rights of the compilation's users
229
+ beyond what the individual works permit. Inclusion of a covered work
230
+ in an aggregate does not cause this License to apply to the other
231
+ parts of the aggregate.
232
+
233
+ 6. Conveying Non-Source Forms.
234
+
235
+ You may convey a covered work in object code form under the terms
236
+ of sections 4 and 5, provided that you also convey the
237
+ machine-readable Corresponding Source under the terms of this License,
238
+ in one of these ways:
239
+
240
+ a) Convey the object code in, or embodied in, a physical product
241
+ (including a physical distribution medium), accompanied by the
242
+ Corresponding Source fixed on a durable physical medium
243
+ customarily used for software interchange.
244
+
245
+ b) Convey the object code in, or embodied in, a physical product
246
+ (including a physical distribution medium), accompanied by a
247
+ written offer, valid for at least three years and valid for as
248
+ long as you offer spare parts or customer support for that product
249
+ model, to give anyone who possesses the object code either (1) a
250
+ copy of the Corresponding Source for all the software in the
251
+ product that is covered by this License, on a durable physical
252
+ medium customarily used for software interchange, for a price no
253
+ more than your reasonable cost of physically performing this
254
+ conveying of source, or (2) access to copy the
255
+ Corresponding Source from a network server at no charge.
256
+
257
+ c) Convey individual copies of the object code with a copy of the
258
+ written offer to provide the Corresponding Source. This
259
+ alternative is allowed only occasionally and noncommercially, and
260
+ only if you received the object code with such an offer, in accord
261
+ with subsection 6b.
262
+
263
+ d) Convey the object code by offering access from a designated
264
+ place (gratis or for a charge), and offer equivalent access to the
265
+ Corresponding Source in the same way through the same place at no
266
+ further charge. You need not require recipients to copy the
267
+ Corresponding Source along with the object code. If the place to
268
+ copy the object code is a network server, the Corresponding Source
269
+ may be on a different server (operated by you or a third party)
270
+ that supports equivalent copying facilities, provided you maintain
271
+ clear directions next to the object code saying where to find the
272
+ Corresponding Source. Regardless of what server hosts the
273
+ Corresponding Source, you remain obligated to ensure that it is
274
+ available for as long as needed to satisfy these requirements.
275
+
276
+ e) Convey the object code using peer-to-peer transmission, provided
277
+ you inform other peers where the object code and Corresponding
278
+ Source of the work are being offered to the general public at no
279
+ charge under subsection 6d.
280
+
281
+ A separable portion of the object code, whose source code is excluded
282
+ from the Corresponding Source as a System Library, need not be
283
+ included in conveying the object code work.
284
+
285
+ A "User Product" is either (1) a "consumer product", which means any
286
+ tangible personal property which is normally used for personal, family,
287
+ or household purposes, or (2) anything designed or sold for incorporation
288
+ into a dwelling. In determining whether a product is a consumer product,
289
+ doubtful cases shall be resolved in favor of coverage. For a particular
290
+ product received by a particular user, "normally used" refers to a
291
+ typical or common use of that class of product, regardless of the status
292
+ of the particular user or of the way in which the particular user
293
+ actually uses, or expects or is expected to use, the product. A product
294
+ is a consumer product regardless of whether the product has substantial
295
+ commercial, industrial or non-consumer uses, unless such uses represent
296
+ the only significant mode of use of the product.
297
+
298
+ "Installation Information" for a User Product means any methods,
299
+ procedures, authorization keys, or other information required to install
300
+ and execute modified versions of a covered work in that User Product from
301
+ a modified version of its Corresponding Source. The information must
302
+ suffice to ensure that the continued functioning of the modified object
303
+ code is in no case prevented or interfered with solely because
304
+ modification has been made.
305
+
306
+ If you convey an object code work under this section in, or with, or
307
+ specifically for use in, a User Product, and the conveying occurs as
308
+ part of a transaction in which the right of possession and use of the
309
+ User Product is transferred to the recipient in perpetuity or for a
310
+ fixed term (regardless of how the transaction is characterized), the
311
+ Corresponding Source conveyed under this section must be accompanied
312
+ by the Installation Information. But this requirement does not apply
313
+ if neither you nor any third party retains the ability to install
314
+ modified object code on the User Product (for example, the work has
315
+ been installed in ROM).
316
+
317
+ The requirement to provide Installation Information does not include a
318
+ requirement to continue to provide support service, warranty, or updates
319
+ for a work that has been modified or installed by the recipient, or for
320
+ the User Product in which it has been modified or installed. Access to a
321
+ network may be denied when the modification itself materially and
322
+ adversely affects the operation of the network or violates the rules and
323
+ protocols for communication across the network.
324
+
325
+ Corresponding Source conveyed, and Installation Information provided,
326
+ in accord with this section must be in a format that is publicly
327
+ documented (and with an implementation available to the public in
328
+ source code form), and must require no special password or key for
329
+ unpacking, reading or copying.
330
+
331
+ 7. Additional Terms.
332
+
333
+ "Additional permissions" are terms that supplement the terms of this
334
+ License by making exceptions from one or more of its conditions.
335
+ Additional permissions that are applicable to the entire Program shall
336
+ be treated as though they were included in this License, to the extent
337
+ that they are valid under applicable law. If additional permissions
338
+ apply only to part of the Program, that part may be used separately
339
+ under those permissions, but the entire Program remains governed by
340
+ this License without regard to the additional permissions.
341
+
342
+ When you convey a copy of a covered work, you may at your option
343
+ remove any additional permissions from that copy, or from any part of
344
+ it. (Additional permissions may be written to require their own
345
+ removal in certain cases when you modify the work.) You may place
346
+ additional permissions on material, added by you to a covered work,
347
+ for which you have or can give appropriate copyright permission.
348
+
349
+ Notwithstanding any other provision of this License, for material you
350
+ add to a covered work, you may (if authorized by the copyright holders of
351
+ that material) supplement the terms of this License with terms:
352
+
353
+ a) Disclaiming warranty or limiting liability differently from the
354
+ terms of sections 15 and 16 of this License; or
355
+
356
+ b) Requiring preservation of specified reasonable legal notices or
357
+ author attributions in that material or in the Appropriate Legal
358
+ Notices displayed by works containing it; or
359
+
360
+ c) Prohibiting misrepresentation of the origin of that material, or
361
+ requiring that modified versions of such material be marked in
362
+ reasonable ways as different from the original version; or
363
+
364
+ d) Limiting the use for publicity purposes of names of licensors or
365
+ authors of the material; or
366
+
367
+ e) Declining to grant rights under trademark law for use of some
368
+ trade names, trademarks, or service marks; or
369
+
370
+ f) Requiring indemnification of licensors and authors of that
371
+ material by anyone who conveys the material (or modified versions of
372
+ it) with contractual assumptions of liability to the recipient, for
373
+ any liability that these contractual assumptions directly impose on
374
+ those licensors and authors.
375
+
376
+ All other non-permissive additional terms are considered "further
377
+ restrictions" within the meaning of section 10. If the Program as you
378
+ received it, or any part of it, contains a notice stating that it is
379
+ governed by this License along with a term that is a further
380
+ restriction, you may remove that term. If a license document contains
381
+ a further restriction but permits relicensing or conveying under this
382
+ License, you may add to a covered work material governed by the terms
383
+ of that license document, provided that the further restriction does
384
+ not survive such relicensing or conveying.
385
+
386
+ If you add terms to a covered work in accord with this section, you
387
+ must place, in the relevant source files, a statement of the
388
+ additional terms that apply to those files, or a notice indicating
389
+ where to find the applicable terms.
390
+
391
+ Additional terms, permissive or non-permissive, may be stated in the
392
+ form of a separately written license, or stated as exceptions;
393
+ the above requirements apply either way.
394
+
395
+ 8. Termination.
396
+
397
+ You may not propagate or modify a covered work except as expressly
398
+ provided under this License. Any attempt otherwise to propagate or
399
+ modify it is void, and will automatically terminate your rights under
400
+ this License (including any patent licenses granted under the third
401
+ paragraph of section 11).
402
+
403
+ However, if you cease all violation of this License, then your
404
+ license from a particular copyright holder is reinstated (a)
405
+ provisionally, unless and until the copyright holder explicitly and
406
+ finally terminates your license, and (b) permanently, if the copyright
407
+ holder fails to notify you of the violation by some reasonable means
408
+ prior to 60 days after the cessation.
409
+
410
+ Moreover, your license from a particular copyright holder is
411
+ reinstated permanently if the copyright holder notifies you of the
412
+ violation by some reasonable means, this is the first time you have
413
+ received notice of violation of this License (for any work) from that
414
+ copyright holder, and you cure the violation prior to 30 days after
415
+ your receipt of the notice.
416
+
417
+ Termination of your rights under this section does not terminate the
418
+ licenses of parties who have received copies or rights from you under
419
+ this License. If your rights have been terminated and not permanently
420
+ reinstated, you do not qualify to receive new licenses for the same
421
+ material under section 10.
422
+
423
+ 9. Acceptance Not Required for Having Copies.
424
+
425
+ You are not required to accept this License in order to receive or
426
+ run a copy of the Program. Ancillary propagation of a covered work
427
+ occurring solely as a consequence of using peer-to-peer transmission
428
+ to receive a copy likewise does not require acceptance. However,
429
+ nothing other than this License grants you permission to propagate or
430
+ modify any covered work. These actions infringe copyright if you do
431
+ not accept this License. Therefore, by modifying or propagating a
432
+ covered work, you indicate your acceptance of this License to do so.
433
+
434
+ 10. Automatic Licensing of Downstream Recipients.
435
+
436
+ Each time you convey a covered work, the recipient automatically
437
+ receives a license from the original licensors, to run, modify and
438
+ propagate that work, subject to this License. You are not responsible
439
+ for enforcing compliance by third parties with this License.
440
+
441
+ An "entity transaction" is a transaction transferring control of an
442
+ organization, or substantially all assets of one, or subdividing an
443
+ organization, or merging organizations. If propagation of a covered
444
+ work results from an entity transaction, each party to that
445
+ transaction who receives a copy of the work also receives whatever
446
+ licenses to the work the party's predecessor in interest had or could
447
+ give under the previous paragraph, plus a right to possession of the
448
+ Corresponding Source of the work from the predecessor in interest, if
449
+ the predecessor has it or can get it with reasonable efforts.
450
+
451
+ You may not impose any further restrictions on the exercise of the
452
+ rights granted or affirmed under this License. For example, you may
453
+ not impose a license fee, royalty, or other charge for exercise of
454
+ rights granted under this License, and you may not initiate litigation
455
+ (including a cross-claim or counterclaim in a lawsuit) alleging that
456
+ any patent claim is infringed by making, using, selling, offering for
457
+ sale, or importing the Program or any portion of it.
458
+
459
+ 11. Patents.
460
+
461
+ A "contributor" is a copyright holder who authorizes use under this
462
+ License of the Program or a work on which the Program is based. The
463
+ work thus licensed is called the contributor's "contributor version".
464
+
465
+ A contributor's "essential patent claims" are all patent claims
466
+ owned or controlled by the contributor, whether already acquired or
467
+ hereafter acquired, that would be infringed by some manner, permitted
468
+ by this License, of making, using, or selling its contributor version,
469
+ but do not include claims that would be infringed only as a
470
+ consequence of further modification of the contributor version. For
471
+ purposes of this definition, "control" includes the right to grant
472
+ patent sublicenses in a manner consistent with the requirements of
473
+ this License.
474
+
475
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
476
+ patent license under the contributor's essential patent claims, to
477
+ make, use, sell, offer for sale, import and otherwise run, modify and
478
+ propagate the contents of its contributor version.
479
+
480
+ In the following three paragraphs, a "patent license" is any express
481
+ agreement or commitment, however denominated, not to enforce a patent
482
+ (such as an express permission to practice a patent or covenant not to
483
+ sue for patent infringement). To "grant" such a patent license to a
484
+ party means to make such an agreement or commitment not to enforce a
485
+ patent against the party.
486
+
487
+ If you convey a covered work, knowingly relying on a patent license,
488
+ and the Corresponding Source of the work is not available for anyone
489
+ to copy, free of charge and under the terms of this License, through a
490
+ publicly available network server or other readily accessible means,
491
+ then you must either (1) cause the Corresponding Source to be so
492
+ available, or (2) arrange to deprive yourself of the benefit of the
493
+ patent license for this particular work, or (3) arrange, in a manner
494
+ consistent with the requirements of this License, to extend the patent
495
+ license to downstream recipients. "Knowingly relying" means you have
496
+ actual knowledge that, but for the patent license, your conveying the
497
+ covered work in a country, or your recipient's use of the covered work
498
+ in a country, would infringe one or more identifiable patents in that
499
+ country that you have reason to believe are valid.
500
+
501
+ If, pursuant to or in connection with a single transaction or
502
+ arrangement, you convey, or propagate by procuring conveyance of, a
503
+ covered work, and grant a patent license to some of the parties
504
+ receiving the covered work authorizing them to use, propagate, modify
505
+ or convey a specific copy of the covered work, then the patent license
506
+ you grant is automatically extended to all recipients of the covered
507
+ work and works based on it.
508
+
509
+ A patent license is "discriminatory" if it does not include within
510
+ the scope of its coverage, prohibits the exercise of, or is
511
+ conditioned on the non-exercise of one or more of the rights that are
512
+ specifically granted under this License. You may not convey a covered
513
+ work if you are a party to an arrangement with a third party that is
514
+ in the business of distributing software, under which you make payment
515
+ to the third party based on the extent of your activity of conveying
516
+ the work, and under which the third party grants, to any of the
517
+ parties who would receive the covered work from you, a discriminatory
518
+ patent license (a) in connection with copies of the covered work
519
+ conveyed by you (or copies made from those copies), or (b) primarily
520
+ for and in connection with specific products or compilations that
521
+ contain the covered work, unless you entered into that arrangement,
522
+ or that patent license was granted, prior to 28 March 2007.
523
+
524
+ Nothing in this License shall be construed as excluding or limiting
525
+ any implied license or other defenses to infringement that may
526
+ otherwise be available to you under applicable patent law.
527
+
528
+ 12. No Surrender of Others' Freedom.
529
+
530
+ If conditions are imposed on you (whether by court order, agreement or
531
+ otherwise) that contradict the conditions of this License, they do not
532
+ excuse you from the conditions of this License. If you cannot convey a
533
+ covered work so as to satisfy simultaneously your obligations under this
534
+ License and any other pertinent obligations, then as a consequence you may
535
+ not convey it at all. For example, if you agree to terms that obligate you
536
+ to collect a royalty for further conveying from those to whom you convey
537
+ the Program, the only way you could satisfy both those terms and this
538
+ License would be to refrain entirely from conveying the Program.
539
+
540
+ 13. Remote Network Interaction; Use with the GNU General Public License.
541
+
542
+ Notwithstanding any other provision of this License, if you modify the
543
+ Program, your modified version must prominently offer all users
544
+ interacting with it remotely through a computer network (if your version
545
+ supports such interaction) an opportunity to receive the Corresponding
546
+ Source of your version by providing access to the Corresponding Source
547
+ from a network server at no charge, through some standard or customary
548
+ means of facilitating copying of software. This Corresponding Source
549
+ shall include the Corresponding Source for any work covered by version 3
550
+ of the GNU General Public License that is incorporated pursuant to the
551
+ following paragraph.
552
+
553
+ Notwithstanding any other provision of this License, you have
554
+ permission to link or combine any covered work with a work licensed
555
+ under version 3 of the GNU General Public License into a single
556
+ combined work, and to convey the resulting work. The terms of this
557
+ License will continue to apply to the part which is the covered work,
558
+ but the work with which it is combined will remain governed by version
559
+ 3 of the GNU General Public License.
560
+
561
+ 14. Revised Versions of this License.
562
+
563
+ The Free Software Foundation may publish revised and/or new versions of
564
+ the GNU Affero General Public License from time to time. Such new versions
565
+ will be similar in spirit to the present version, but may differ in detail to
566
+ address new problems or concerns.
567
+
568
+ Each version is given a distinguishing version number. If the
569
+ Program specifies that a certain numbered version of the GNU Affero General
570
+ Public License "or any later version" applies to it, you have the
571
+ option of following the terms and conditions either of that numbered
572
+ version or of any later version published by the Free Software
573
+ Foundation. If the Program does not specify a version number of the
574
+ GNU Affero General Public License, you may choose any version ever published
575
+ by the Free Software Foundation.
576
+
577
+ If the Program specifies that a proxy can decide which future
578
+ versions of the GNU Affero General Public License can be used, that proxy's
579
+ public statement of acceptance of a version permanently authorizes you
580
+ to choose that version for the Program.
581
+
582
+ Later license versions may give you additional or different
583
+ permissions. However, no additional obligations are imposed on any
584
+ author or copyright holder as a result of your choosing to follow a
585
+ later version.
586
+
587
+ 15. Disclaimer of Warranty.
588
+
589
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
590
+ APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
591
+ HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
592
+ OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
593
+ THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
594
+ PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
595
+ IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
596
+ ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
597
+
598
+ 16. Limitation of Liability.
599
+
600
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
602
+ THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
603
+ GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
604
+ USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
605
+ DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
606
+ PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
607
+ EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
608
+ SUCH DAMAGES.
609
+
610
+ 17. Interpretation of Sections 15 and 16.
611
+
612
+ If the disclaimer of warranty and limitation of liability provided
613
+ above cannot be given local legal effect according to their terms,
614
+ reviewing courts shall apply local law that most closely approximates
615
+ an absolute waiver of all civil liability in connection with the
616
+ Program, unless a warranty or assumption of liability accompanies a
617
+ copy of the Program in return for a fee.
618
+
619
+ END OF TERMS AND CONDITIONS
620
+
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Immich
3
- * 1.138.0
3
+ * 2.1.0
4
4
  * DO NOT MODIFY - This file has been generated using oazapfts.
5
5
  * See https://www.npmjs.com/package/oazapfts
6
6
  */
@@ -312,6 +312,8 @@ export type TagResponseDto = {
312
312
  export type AssetResponseDto = {
313
313
  /** base64 encoded sha1 hash */
314
314
  checksum: string;
315
+ /** The UTC timestamp when the asset was originally uploaded to Immich. */
316
+ createdAt: string;
315
317
  deviceAssetId: string;
316
318
  deviceId: string;
317
319
  duplicateId?: string | null;
@@ -379,6 +381,14 @@ export type CreateAlbumDto = {
379
381
  assetIds?: string[];
380
382
  description?: string;
381
383
  };
384
+ export type AlbumsAddAssetsDto = {
385
+ albumIds: string[];
386
+ assetIds: string[];
387
+ };
388
+ export type AlbumsAddAssetsResponseDto = {
389
+ error?: BulkIdErrorReason;
390
+ success: boolean;
391
+ };
382
392
  export type AlbumStatisticsResponseDto = {
383
393
  notShared: number;
384
394
  owned: number;
@@ -432,6 +442,10 @@ export type AssetBulkDeleteDto = {
432
442
  force?: boolean;
433
443
  ids: string[];
434
444
  };
445
+ export type AssetMetadataUpsertItemDto = {
446
+ key: AssetMetadataKey;
447
+ value: object;
448
+ };
435
449
  export type AssetMediaCreateDto = {
436
450
  assetData: Blob;
437
451
  deviceAssetId: string;
@@ -442,6 +456,7 @@ export type AssetMediaCreateDto = {
442
456
  filename?: string;
443
457
  isFavorite?: boolean;
444
458
  livePhotoVideoId?: string;
459
+ metadata: AssetMetadataUpsertItemDto[];
445
460
  sidecarData?: Blob;
446
461
  visibility?: AssetVisibility;
447
462
  };
@@ -501,6 +516,14 @@ export type UpdateAssetDto = {
501
516
  rating?: number;
502
517
  visibility?: AssetVisibility;
503
518
  };
519
+ export type AssetMetadataResponseDto = {
520
+ key: AssetMetadataKey;
521
+ updatedAt: string;
522
+ value: object;
523
+ };
524
+ export type AssetMetadataUpsertDto = {
525
+ items: AssetMetadataUpsertItemDto[];
526
+ };
504
527
  export type AssetMediaReplaceDto = {
505
528
  assetData: Blob;
506
529
  deviceAssetId: string;
@@ -783,7 +806,10 @@ export type PartnerResponseDto = {
783
806
  profileChangedAt: string;
784
807
  profileImagePath: string;
785
808
  };
786
- export type UpdatePartnerDto = {
809
+ export type PartnerCreateDto = {
810
+ sharedWithId: string;
811
+ };
812
+ export type PartnerUpdateDto = {
787
813
  inTimeline: boolean;
788
814
  };
789
815
  export type PeopleResponseDto = {
@@ -986,7 +1012,8 @@ export type SmartSearchDto = {
986
1012
  model?: string | null;
987
1013
  page?: number;
988
1014
  personIds?: string[];
989
- query: string;
1015
+ query?: string;
1016
+ queryAssetId?: string;
990
1017
  rating?: number;
991
1018
  size?: number;
992
1019
  state?: string | null;
@@ -1351,6 +1378,11 @@ export type SystemConfigLoggingDto = {
1351
1378
  enabled: boolean;
1352
1379
  level: LogLevel;
1353
1380
  };
1381
+ export type MachineLearningAvailabilityChecksDto = {
1382
+ enabled: boolean;
1383
+ interval: number;
1384
+ timeout: number;
1385
+ };
1354
1386
  export type ClipConfig = {
1355
1387
  enabled: boolean;
1356
1388
  modelName: string;
@@ -1367,12 +1399,11 @@ export type FacialRecognitionConfig = {
1367
1399
  modelName: string;
1368
1400
  };
1369
1401
  export type SystemConfigMachineLearningDto = {
1402
+ availabilityChecks: MachineLearningAvailabilityChecksDto;
1370
1403
  clip: ClipConfig;
1371
1404
  duplicateDetection: DuplicateDetectionConfig;
1372
1405
  enabled: boolean;
1373
1406
  facialRecognition: FacialRecognitionConfig;
1374
- /** This property was deprecated in v1.122.0 */
1375
- url?: string;
1376
1407
  urls: string[];
1377
1408
  };
1378
1409
  export type SystemConfigMapDto = {
@@ -1529,10 +1560,14 @@ export type TimeBucketAssetResponseDto = {
1529
1560
  isImage: boolean[];
1530
1561
  /** Array indicating whether each asset is in the trash */
1531
1562
  isTrashed: boolean[];
1563
+ /** Array of latitude coordinates extracted from EXIF GPS data */
1564
+ latitude?: (number | null)[];
1532
1565
  /** Array of live photo video asset IDs (null for non-live photos) */
1533
1566
  livePhotoVideoId: (string | null)[];
1534
1567
  /** Array of UTC offset hours at the time each photo was taken. Positive values are east of UTC, negative values are west of UTC. Values may be fractional (e.g., 5.5 for +05:30, -9.75 for -09:45). Applying this offset to 'fileCreatedAt' will give you the time the photo was taken from the photographer's perspective. */
1535
1568
  localOffsetHours: number[];
1569
+ /** Array of longitude coordinates extracted from EXIF GPS data */
1570
+ longitude?: (number | null)[];
1536
1571
  /** Array of owner IDs for each asset */
1537
1572
  ownerId: string[];
1538
1573
  /** Array of projection types for 360° content (e.g., "EQUIRECTANGULAR", "CUBEFACE", "CYLINDRICAL") */
@@ -1692,6 +1727,14 @@ export declare function getAllAlbums({ assetId, shared }: {
1692
1727
  export declare function createAlbum({ createAlbumDto }: {
1693
1728
  createAlbumDto: CreateAlbumDto;
1694
1729
  }, opts?: Oazapfts.RequestOpts): Promise<AlbumResponseDto>;
1730
+ /**
1731
+ * This endpoint requires the `albumAsset.create` permission.
1732
+ */
1733
+ export declare function addAssetsToAlbums({ key, slug, albumsAddAssetsDto }: {
1734
+ key?: string;
1735
+ slug?: string;
1736
+ albumsAddAssetsDto: AlbumsAddAssetsDto;
1737
+ }, opts?: Oazapfts.RequestOpts): Promise<AlbumsAddAssetsResponseDto>;
1695
1738
  /**
1696
1739
  * This endpoint requires the `album.statistics` permission.
1697
1740
  */
@@ -1766,6 +1809,7 @@ export declare function getApiKeys(opts?: Oazapfts.RequestOpts): Promise<ApiKeyR
1766
1809
  export declare function createApiKey({ apiKeyCreateDto }: {
1767
1810
  apiKeyCreateDto: ApiKeyCreateDto;
1768
1811
  }, opts?: Oazapfts.RequestOpts): Promise<ApiKeyCreateResponseDto>;
1812
+ export declare function getMyApiKey(opts?: Oazapfts.RequestOpts): Promise<ApiKeyResponseDto>;
1769
1813
  /**
1770
1814
  * This endpoint requires the `apiKey.delete` permission.
1771
1815
  */
@@ -1856,6 +1900,33 @@ export declare function updateAsset({ id, updateAssetDto }: {
1856
1900
  id: string;
1857
1901
  updateAssetDto: UpdateAssetDto;
1858
1902
  }, opts?: Oazapfts.RequestOpts): Promise<AssetResponseDto>;
1903
+ /**
1904
+ * This endpoint requires the `asset.read` permission.
1905
+ */
1906
+ export declare function getAssetMetadata({ id }: {
1907
+ id: string;
1908
+ }, opts?: Oazapfts.RequestOpts): Promise<AssetMetadataResponseDto[]>;
1909
+ /**
1910
+ * This endpoint requires the `asset.update` permission.
1911
+ */
1912
+ export declare function updateAssetMetadata({ id, assetMetadataUpsertDto }: {
1913
+ id: string;
1914
+ assetMetadataUpsertDto: AssetMetadataUpsertDto;
1915
+ }, opts?: Oazapfts.RequestOpts): Promise<AssetMetadataResponseDto[]>;
1916
+ /**
1917
+ * This endpoint requires the `asset.update` permission.
1918
+ */
1919
+ export declare function deleteAssetMetadata({ id, key }: {
1920
+ id: string;
1921
+ key: AssetMetadataKey;
1922
+ }, opts?: Oazapfts.RequestOpts): Promise<never>;
1923
+ /**
1924
+ * This endpoint requires the `asset.read` permission.
1925
+ */
1926
+ export declare function getAssetMetadataByKey({ id, key }: {
1927
+ id: string;
1928
+ key: AssetMetadataKey;
1929
+ }, opts?: Oazapfts.RequestOpts): Promise<AssetMetadataResponseDto>;
1859
1930
  /**
1860
1931
  * This endpoint requires the `asset.download` permission.
1861
1932
  */
@@ -1865,7 +1936,7 @@ export declare function downloadAsset({ id, key, slug }: {
1865
1936
  slug?: string;
1866
1937
  }, opts?: Oazapfts.RequestOpts): Promise<Blob>;
1867
1938
  /**
1868
- * replaceAsset
1939
+ * Replace the asset with new file, without changing its id
1869
1940
  */
1870
1941
  export declare function replaceAsset({ id, key, slug, assetMediaReplaceDto }: {
1871
1942
  id: string;
@@ -2173,6 +2244,12 @@ export declare function unlinkOAuthAccount(opts?: Oazapfts.RequestOpts): Promise
2173
2244
  export declare function getPartners({ direction }: {
2174
2245
  direction: PartnerDirection;
2175
2246
  }, opts?: Oazapfts.RequestOpts): Promise<PartnerResponseDto[]>;
2247
+ /**
2248
+ * This endpoint requires the `partner.create` permission.
2249
+ */
2250
+ export declare function createPartner({ partnerCreateDto }: {
2251
+ partnerCreateDto: PartnerCreateDto;
2252
+ }, opts?: Oazapfts.RequestOpts): Promise<PartnerResponseDto>;
2176
2253
  /**
2177
2254
  * This endpoint requires the `partner.delete` permission.
2178
2255
  */
@@ -2180,17 +2257,17 @@ export declare function removePartner({ id }: {
2180
2257
  id: string;
2181
2258
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2182
2259
  /**
2183
- * This endpoint requires the `partner.create` permission.
2260
+ * This property was deprecated in v1.141.0. This endpoint requires the `partner.create` permission.
2184
2261
  */
2185
- export declare function createPartner({ id }: {
2262
+ export declare function createPartnerDeprecated({ id }: {
2186
2263
  id: string;
2187
2264
  }, opts?: Oazapfts.RequestOpts): Promise<PartnerResponseDto>;
2188
2265
  /**
2189
2266
  * This endpoint requires the `partner.update` permission.
2190
2267
  */
2191
- export declare function updatePartner({ id, updatePartnerDto }: {
2268
+ export declare function updatePartner({ id, partnerUpdateDto }: {
2192
2269
  id: string;
2193
- updatePartnerDto: UpdatePartnerDto;
2270
+ partnerUpdateDto: PartnerUpdateDto;
2194
2271
  }, opts?: Oazapfts.RequestOpts): Promise<PartnerResponseDto>;
2195
2272
  /**
2196
2273
  * This endpoint requires the `person.delete` permission.
@@ -2646,7 +2723,7 @@ export declare function tagAssets({ id, bulkIdsDto }: {
2646
2723
  /**
2647
2724
  * This endpoint requires the `asset.read` permission.
2648
2725
  */
2649
- export declare function getTimeBucket({ albumId, isFavorite, isTrashed, key, order, personId, slug, tagId, timeBucket, userId, visibility, withPartners, withStacked }: {
2726
+ export declare function getTimeBucket({ albumId, isFavorite, isTrashed, key, order, personId, slug, tagId, timeBucket, userId, visibility, withCoordinates, withPartners, withStacked }: {
2650
2727
  albumId?: string;
2651
2728
  isFavorite?: boolean;
2652
2729
  isTrashed?: boolean;
@@ -2658,13 +2735,14 @@ export declare function getTimeBucket({ albumId, isFavorite, isTrashed, key, ord
2658
2735
  timeBucket: string;
2659
2736
  userId?: string;
2660
2737
  visibility?: AssetVisibility;
2738
+ withCoordinates?: boolean;
2661
2739
  withPartners?: boolean;
2662
2740
  withStacked?: boolean;
2663
2741
  }, opts?: Oazapfts.RequestOpts): Promise<TimeBucketAssetResponseDto>;
2664
2742
  /**
2665
2743
  * This endpoint requires the `asset.read` permission.
2666
2744
  */
2667
- export declare function getTimeBuckets({ albumId, isFavorite, isTrashed, key, order, personId, slug, tagId, userId, visibility, withPartners, withStacked }: {
2745
+ export declare function getTimeBuckets({ albumId, isFavorite, isTrashed, key, order, personId, slug, tagId, userId, visibility, withCoordinates, withPartners, withStacked }: {
2668
2746
  albumId?: string;
2669
2747
  isFavorite?: boolean;
2670
2748
  isTrashed?: boolean;
@@ -2675,6 +2753,7 @@ export declare function getTimeBuckets({ albumId, isFavorite, isTrashed, key, or
2675
2753
  tagId?: string;
2676
2754
  userId?: string;
2677
2755
  visibility?: AssetVisibility;
2756
+ withCoordinates?: boolean;
2678
2757
  withPartners?: boolean;
2679
2758
  withStacked?: boolean;
2680
2759
  }, opts?: Oazapfts.RequestOpts): Promise<TimeBucketsResponseDto[]>;
@@ -2800,6 +2879,8 @@ export declare enum NotificationType {
2800
2879
  JobFailed = "JobFailed",
2801
2880
  BackupFailed = "BackupFailed",
2802
2881
  SystemMessage = "SystemMessage",
2882
+ AlbumInvite = "AlbumInvite",
2883
+ AlbumUpdate = "AlbumUpdate",
2803
2884
  Custom = "Custom"
2804
2885
  }
2805
2886
  export declare enum UserStatus {
@@ -2832,6 +2913,12 @@ export declare enum AssetTypeEnum {
2832
2913
  Audio = "AUDIO",
2833
2914
  Other = "OTHER"
2834
2915
  }
2916
+ export declare enum BulkIdErrorReason {
2917
+ Duplicate = "duplicate",
2918
+ NoPermission = "no_permission",
2919
+ NotFound = "not_found",
2920
+ Unknown = "unknown"
2921
+ }
2835
2922
  export declare enum Error {
2836
2923
  Duplicate = "duplicate",
2837
2924
  NoPermission = "no_permission",
@@ -2968,6 +3055,9 @@ export declare enum Permission {
2968
3055
  AdminUserDelete = "adminUser.delete",
2969
3056
  AdminAuthUnlinkAll = "adminAuth.unlinkAll"
2970
3057
  }
3058
+ export declare enum AssetMetadataKey {
3059
+ MobileApp = "mobile-app"
3060
+ }
2971
3061
  export declare enum AssetMediaStatus {
2972
3062
  Created = "created",
2973
3063
  Replaced = "replaced",
@@ -3054,6 +3144,8 @@ export declare enum SyncEntityType {
3054
3144
  AssetV1 = "AssetV1",
3055
3145
  AssetDeleteV1 = "AssetDeleteV1",
3056
3146
  AssetExifV1 = "AssetExifV1",
3147
+ AssetMetadataV1 = "AssetMetadataV1",
3148
+ AssetMetadataDeleteV1 = "AssetMetadataDeleteV1",
3057
3149
  PartnerV1 = "PartnerV1",
3058
3150
  PartnerDeleteV1 = "PartnerDeleteV1",
3059
3151
  PartnerAssetV1 = "PartnerAssetV1",
@@ -3091,7 +3183,8 @@ export declare enum SyncEntityType {
3091
3183
  UserMetadataV1 = "UserMetadataV1",
3092
3184
  UserMetadataDeleteV1 = "UserMetadataDeleteV1",
3093
3185
  SyncAckV1 = "SyncAckV1",
3094
- SyncResetV1 = "SyncResetV1"
3186
+ SyncResetV1 = "SyncResetV1",
3187
+ SyncCompleteV1 = "SyncCompleteV1"
3095
3188
  }
3096
3189
  export declare enum SyncRequestType {
3097
3190
  AlbumsV1 = "AlbumsV1",
@@ -3101,6 +3194,7 @@ export declare enum SyncRequestType {
3101
3194
  AlbumAssetExifsV1 = "AlbumAssetExifsV1",
3102
3195
  AssetsV1 = "AssetsV1",
3103
3196
  AssetExifsV1 = "AssetExifsV1",
3197
+ AssetMetadataV1 = "AssetMetadataV1",
3104
3198
  AuthUsersV1 = "AuthUsersV1",
3105
3199
  MemoriesV1 = "MemoriesV1",
3106
3200
  MemoryToAssetsV1 = "MemoryToAssetsV1",
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Immich
3
- * 1.138.0
3
+ * 2.1.0
4
4
  * DO NOT MODIFY - This file has been generated using oazapfts.
5
5
  * See https://www.npmjs.com/package/oazapfts
6
6
  */
@@ -197,6 +197,19 @@ export function createAlbum({ createAlbumDto }, opts) {
197
197
  body: createAlbumDto
198
198
  })));
199
199
  }
200
+ /**
201
+ * This endpoint requires the `albumAsset.create` permission.
202
+ */
203
+ export function addAssetsToAlbums({ key, slug, albumsAddAssetsDto }, opts) {
204
+ return oazapfts.ok(oazapfts.fetchJson(`/albums/assets${QS.query(QS.explode({
205
+ key,
206
+ slug
207
+ }))}`, oazapfts.json({
208
+ ...opts,
209
+ method: "PUT",
210
+ body: albumsAddAssetsDto
211
+ })));
212
+ }
200
213
  /**
201
214
  * This endpoint requires the `album.statistics` permission.
202
215
  */
@@ -306,6 +319,11 @@ export function createApiKey({ apiKeyCreateDto }, opts) {
306
319
  body: apiKeyCreateDto
307
320
  })));
308
321
  }
322
+ export function getMyApiKey(opts) {
323
+ return oazapfts.ok(oazapfts.fetchJson("/api-keys/me", {
324
+ ...opts
325
+ }));
326
+ }
309
327
  /**
310
328
  * This endpoint requires the `apiKey.delete` permission.
311
329
  */
@@ -447,6 +465,41 @@ export function updateAsset({ id, updateAssetDto }, opts) {
447
465
  body: updateAssetDto
448
466
  })));
449
467
  }
468
+ /**
469
+ * This endpoint requires the `asset.read` permission.
470
+ */
471
+ export function getAssetMetadata({ id }, opts) {
472
+ return oazapfts.ok(oazapfts.fetchJson(`/assets/${encodeURIComponent(id)}/metadata`, {
473
+ ...opts
474
+ }));
475
+ }
476
+ /**
477
+ * This endpoint requires the `asset.update` permission.
478
+ */
479
+ export function updateAssetMetadata({ id, assetMetadataUpsertDto }, opts) {
480
+ return oazapfts.ok(oazapfts.fetchJson(`/assets/${encodeURIComponent(id)}/metadata`, oazapfts.json({
481
+ ...opts,
482
+ method: "PUT",
483
+ body: assetMetadataUpsertDto
484
+ })));
485
+ }
486
+ /**
487
+ * This endpoint requires the `asset.update` permission.
488
+ */
489
+ export function deleteAssetMetadata({ id, key }, opts) {
490
+ return oazapfts.ok(oazapfts.fetchText(`/assets/${encodeURIComponent(id)}/metadata/${encodeURIComponent(key)}`, {
491
+ ...opts,
492
+ method: "DELETE"
493
+ }));
494
+ }
495
+ /**
496
+ * This endpoint requires the `asset.read` permission.
497
+ */
498
+ export function getAssetMetadataByKey({ id, key }, opts) {
499
+ return oazapfts.ok(oazapfts.fetchJson(`/assets/${encodeURIComponent(id)}/metadata/${encodeURIComponent(key)}`, {
500
+ ...opts
501
+ }));
502
+ }
450
503
  /**
451
504
  * This endpoint requires the `asset.download` permission.
452
505
  */
@@ -459,7 +512,7 @@ export function downloadAsset({ id, key, slug }, opts) {
459
512
  }));
460
513
  }
461
514
  /**
462
- * replaceAsset
515
+ * Replace the asset with new file, without changing its id
463
516
  */
464
517
  export function replaceAsset({ id, key, slug, assetMediaReplaceDto }, opts) {
465
518
  return oazapfts.ok(oazapfts.fetchJson(`/assets/${encodeURIComponent(id)}/original${QS.query(QS.explode({
@@ -973,6 +1026,16 @@ export function getPartners({ direction }, opts) {
973
1026
  ...opts
974
1027
  }));
975
1028
  }
1029
+ /**
1030
+ * This endpoint requires the `partner.create` permission.
1031
+ */
1032
+ export function createPartner({ partnerCreateDto }, opts) {
1033
+ return oazapfts.ok(oazapfts.fetchJson("/partners", oazapfts.json({
1034
+ ...opts,
1035
+ method: "POST",
1036
+ body: partnerCreateDto
1037
+ })));
1038
+ }
976
1039
  /**
977
1040
  * This endpoint requires the `partner.delete` permission.
978
1041
  */
@@ -983,9 +1046,9 @@ export function removePartner({ id }, opts) {
983
1046
  }));
984
1047
  }
985
1048
  /**
986
- * This endpoint requires the `partner.create` permission.
1049
+ * This property was deprecated in v1.141.0. This endpoint requires the `partner.create` permission.
987
1050
  */
988
- export function createPartner({ id }, opts) {
1051
+ export function createPartnerDeprecated({ id }, opts) {
989
1052
  return oazapfts.ok(oazapfts.fetchJson(`/partners/${encodeURIComponent(id)}`, {
990
1053
  ...opts,
991
1054
  method: "POST"
@@ -994,11 +1057,11 @@ export function createPartner({ id }, opts) {
994
1057
  /**
995
1058
  * This endpoint requires the `partner.update` permission.
996
1059
  */
997
- export function updatePartner({ id, updatePartnerDto }, opts) {
1060
+ export function updatePartner({ id, partnerUpdateDto }, opts) {
998
1061
  return oazapfts.ok(oazapfts.fetchJson(`/partners/${encodeURIComponent(id)}`, oazapfts.json({
999
1062
  ...opts,
1000
1063
  method: "PUT",
1001
- body: updatePartnerDto
1064
+ body: partnerUpdateDto
1002
1065
  })));
1003
1066
  }
1004
1067
  /**
@@ -1749,7 +1812,7 @@ export function tagAssets({ id, bulkIdsDto }, opts) {
1749
1812
  /**
1750
1813
  * This endpoint requires the `asset.read` permission.
1751
1814
  */
1752
- export function getTimeBucket({ albumId, isFavorite, isTrashed, key, order, personId, slug, tagId, timeBucket, userId, visibility, withPartners, withStacked }, opts) {
1815
+ export function getTimeBucket({ albumId, isFavorite, isTrashed, key, order, personId, slug, tagId, timeBucket, userId, visibility, withCoordinates, withPartners, withStacked }, opts) {
1753
1816
  return oazapfts.ok(oazapfts.fetchJson(`/timeline/bucket${QS.query(QS.explode({
1754
1817
  albumId,
1755
1818
  isFavorite,
@@ -1762,6 +1825,7 @@ export function getTimeBucket({ albumId, isFavorite, isTrashed, key, order, pers
1762
1825
  timeBucket,
1763
1826
  userId,
1764
1827
  visibility,
1828
+ withCoordinates,
1765
1829
  withPartners,
1766
1830
  withStacked
1767
1831
  }))}`, {
@@ -1771,7 +1835,7 @@ export function getTimeBucket({ albumId, isFavorite, isTrashed, key, order, pers
1771
1835
  /**
1772
1836
  * This endpoint requires the `asset.read` permission.
1773
1837
  */
1774
- export function getTimeBuckets({ albumId, isFavorite, isTrashed, key, order, personId, slug, tagId, userId, visibility, withPartners, withStacked }, opts) {
1838
+ export function getTimeBuckets({ albumId, isFavorite, isTrashed, key, order, personId, slug, tagId, userId, visibility, withCoordinates, withPartners, withStacked }, opts) {
1775
1839
  return oazapfts.ok(oazapfts.fetchJson(`/timeline/buckets${QS.query(QS.explode({
1776
1840
  albumId,
1777
1841
  isFavorite,
@@ -1783,6 +1847,7 @@ export function getTimeBuckets({ albumId, isFavorite, isTrashed, key, order, per
1783
1847
  tagId,
1784
1848
  userId,
1785
1849
  visibility,
1850
+ withCoordinates,
1786
1851
  withPartners,
1787
1852
  withStacked
1788
1853
  }))}`, {
@@ -1997,6 +2062,8 @@ export var NotificationType;
1997
2062
  NotificationType["JobFailed"] = "JobFailed";
1998
2063
  NotificationType["BackupFailed"] = "BackupFailed";
1999
2064
  NotificationType["SystemMessage"] = "SystemMessage";
2065
+ NotificationType["AlbumInvite"] = "AlbumInvite";
2066
+ NotificationType["AlbumUpdate"] = "AlbumUpdate";
2000
2067
  NotificationType["Custom"] = "Custom";
2001
2068
  })(NotificationType || (NotificationType = {}));
2002
2069
  export var UserStatus;
@@ -2035,6 +2102,13 @@ export var AssetTypeEnum;
2035
2102
  AssetTypeEnum["Audio"] = "AUDIO";
2036
2103
  AssetTypeEnum["Other"] = "OTHER";
2037
2104
  })(AssetTypeEnum || (AssetTypeEnum = {}));
2105
+ export var BulkIdErrorReason;
2106
+ (function (BulkIdErrorReason) {
2107
+ BulkIdErrorReason["Duplicate"] = "duplicate";
2108
+ BulkIdErrorReason["NoPermission"] = "no_permission";
2109
+ BulkIdErrorReason["NotFound"] = "not_found";
2110
+ BulkIdErrorReason["Unknown"] = "unknown";
2111
+ })(BulkIdErrorReason || (BulkIdErrorReason = {}));
2038
2112
  export var Error;
2039
2113
  (function (Error) {
2040
2114
  Error["Duplicate"] = "duplicate";
@@ -2173,6 +2247,10 @@ export var Permission;
2173
2247
  Permission["AdminUserDelete"] = "adminUser.delete";
2174
2248
  Permission["AdminAuthUnlinkAll"] = "adminAuth.unlinkAll";
2175
2249
  })(Permission || (Permission = {}));
2250
+ export var AssetMetadataKey;
2251
+ (function (AssetMetadataKey) {
2252
+ AssetMetadataKey["MobileApp"] = "mobile-app";
2253
+ })(AssetMetadataKey || (AssetMetadataKey = {}));
2176
2254
  export var AssetMediaStatus;
2177
2255
  (function (AssetMediaStatus) {
2178
2256
  AssetMediaStatus["Created"] = "created";
@@ -2273,6 +2351,8 @@ export var SyncEntityType;
2273
2351
  SyncEntityType["AssetV1"] = "AssetV1";
2274
2352
  SyncEntityType["AssetDeleteV1"] = "AssetDeleteV1";
2275
2353
  SyncEntityType["AssetExifV1"] = "AssetExifV1";
2354
+ SyncEntityType["AssetMetadataV1"] = "AssetMetadataV1";
2355
+ SyncEntityType["AssetMetadataDeleteV1"] = "AssetMetadataDeleteV1";
2276
2356
  SyncEntityType["PartnerV1"] = "PartnerV1";
2277
2357
  SyncEntityType["PartnerDeleteV1"] = "PartnerDeleteV1";
2278
2358
  SyncEntityType["PartnerAssetV1"] = "PartnerAssetV1";
@@ -2311,6 +2391,7 @@ export var SyncEntityType;
2311
2391
  SyncEntityType["UserMetadataDeleteV1"] = "UserMetadataDeleteV1";
2312
2392
  SyncEntityType["SyncAckV1"] = "SyncAckV1";
2313
2393
  SyncEntityType["SyncResetV1"] = "SyncResetV1";
2394
+ SyncEntityType["SyncCompleteV1"] = "SyncCompleteV1";
2314
2395
  })(SyncEntityType || (SyncEntityType = {}));
2315
2396
  export var SyncRequestType;
2316
2397
  (function (SyncRequestType) {
@@ -2321,6 +2402,7 @@ export var SyncRequestType;
2321
2402
  SyncRequestType["AlbumAssetExifsV1"] = "AlbumAssetExifsV1";
2322
2403
  SyncRequestType["AssetsV1"] = "AssetsV1";
2323
2404
  SyncRequestType["AssetExifsV1"] = "AssetExifsV1";
2405
+ SyncRequestType["AssetMetadataV1"] = "AssetMetadataV1";
2324
2406
  SyncRequestType["AuthUsersV1"] = "AuthUsersV1";
2325
2407
  SyncRequestType["MemoriesV1"] = "MemoriesV1";
2326
2408
  SyncRequestType["MemoryToAssetsV1"] = "MemoryToAssetsV1";
package/build/index.d.ts CHANGED
@@ -3,11 +3,14 @@ export * from './fetch-errors.js';
3
3
  export interface InitOptions {
4
4
  baseUrl: string;
5
5
  apiKey: string;
6
+ headers?: Record<string, string>;
6
7
  }
7
- export declare const init: ({ baseUrl, apiKey }: InitOptions) => void;
8
+ export declare const init: ({ baseUrl, apiKey, headers }: InitOptions) => void;
8
9
  export declare const getBaseUrl: () => string;
9
10
  export declare const setBaseUrl: (baseUrl: string) => void;
10
11
  export declare const setApiKey: (apiKey: string) => void;
12
+ export declare const setHeader: (key: string, value: string) => void;
13
+ export declare const setHeaders: (headers: Record<string, string>) => void;
11
14
  export declare const getAssetOriginalPath: (id: string) => string;
12
15
  export declare const getAssetThumbnailPath: (id: string) => string;
13
16
  export declare const getAssetPlaybackPath: (id: string) => string;
package/build/index.js CHANGED
@@ -1,9 +1,12 @@
1
1
  import { defaults } from './fetch-client.js';
2
2
  export * from './fetch-client.js';
3
3
  export * from './fetch-errors.js';
4
- export const init = ({ baseUrl, apiKey }) => {
4
+ export const init = ({ baseUrl, apiKey, headers }) => {
5
5
  setBaseUrl(baseUrl);
6
6
  setApiKey(apiKey);
7
+ if (headers) {
8
+ setHeaders(headers);
9
+ }
7
10
  };
8
11
  export const getBaseUrl = () => defaults.baseUrl;
9
12
  export const setBaseUrl = (baseUrl) => {
@@ -13,6 +16,23 @@ export const setApiKey = (apiKey) => {
13
16
  defaults.headers = defaults.headers || {};
14
17
  defaults.headers['x-api-key'] = apiKey;
15
18
  };
19
+ export const setHeader = (key, value) => {
20
+ assertNoApiKey(key);
21
+ defaults.headers = defaults.headers || {};
22
+ defaults.headers[key] = value;
23
+ };
24
+ export const setHeaders = (headers) => {
25
+ defaults.headers = defaults.headers || {};
26
+ for (const [key, value] of Object.entries(headers)) {
27
+ assertNoApiKey(key);
28
+ defaults.headers[key] = value;
29
+ }
30
+ };
31
+ const assertNoApiKey = (headerKey) => {
32
+ if (headerKey.toLowerCase() === 'x-api-key') {
33
+ throw new Error('The API key header can only be set using setApiKey().');
34
+ }
35
+ };
16
36
  export const getAssetOriginalPath = (id) => `/assets/${id}/original`;
17
37
  export const getAssetThumbnailPath = (id) => `/assets/${id}/thumbnail`;
18
38
  export const getAssetPlaybackPath = (id) => `/assets/${id}/video/playback`;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@immich/sdk",
3
- "version": "1.138.0",
3
+ "version": "2.1.0",
4
4
  "description": "Auto-generated TypeScript SDK for the Immich API",
5
5
  "type": "module",
6
6
  "main": "./build/index.js",
@@ -11,15 +11,12 @@
11
11
  "default": "./build/index.js"
12
12
  }
13
13
  },
14
- "scripts": {
15
- "build": "tsc"
16
- },
17
14
  "license": "GNU Affero General Public License version 3",
18
15
  "dependencies": {
19
16
  "@oazapfts/runtime": "^1.0.2"
20
17
  },
21
18
  "devDependencies": {
22
- "@types/node": "^22.17.0",
19
+ "@types/node": "^22.18.8",
23
20
  "typescript": "^5.3.3"
24
21
  },
25
22
  "repository": {
@@ -28,6 +25,9 @@
28
25
  "directory": "open-api/typescript-sdk"
29
26
  },
30
27
  "volta": {
31
- "node": "22.18.0"
28
+ "node": "22.20.0"
29
+ },
30
+ "scripts": {
31
+ "build": "tsc"
32
32
  }
33
- }
33
+ }