apimo.js 1.0.3 → 1.0.4
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/LICENSE +7 -0
- package/README.md +8 -0
- package/dist/index.d.ts +3 -1
- package/dist/schemas/agency.d.ts +3 -0
- package/dist/schemas/common.d.ts +2 -0
- package/dist/schemas/property.d.ts +15 -0
- package/package.json +1 -1
package/LICENSE
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
Copyright 2025 Vitaly Lysen
|
|
2
|
+
|
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
4
|
+
|
|
5
|
+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
6
|
+
|
|
7
|
+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
package/README.md
CHANGED
|
@@ -346,6 +346,14 @@ To use this library, you need:
|
|
|
346
346
|
|
|
347
347
|
Contact [Apimo customer service](https://apimo.net/en/contact/) to request your credentials.
|
|
348
348
|
|
|
349
|
+
## Currently Missing Features
|
|
350
|
+
|
|
351
|
+
- [ ] **Hardened error handling**: More robust error handling for API responses
|
|
352
|
+
- [ ] **Exported types & schemas**: Export all internal types & schemas for better TypeScript integration & validation
|
|
353
|
+
- [ ] **Minified build**: Smaller production build size
|
|
354
|
+
- [ ] **Documentation for all methods**: Complete API documentation for all available methods
|
|
355
|
+
- [ ] **More comprehensive tests**: Additional test coverage for edge cases
|
|
356
|
+
|
|
349
357
|
## Support
|
|
350
358
|
|
|
351
359
|
- 📖 [Apimo API Documentation](https://apimo.net/en/api/webservice/)
|
package/dist/index.d.ts
CHANGED
|
@@ -2,7 +2,9 @@ export type { CatalogName } from './consts/catalogs';
|
|
|
2
2
|
export type { ApiCulture } from './consts/languages';
|
|
3
3
|
export { type AdditionalConfig, Apimo, DEFAULT_ADDITIONAL_CONFIG, DEFAULT_BASE_URL } from './core/api';
|
|
4
4
|
export { Apimo as Api } from './core/api';
|
|
5
|
-
export type {
|
|
5
|
+
export type { ApimoAgency, ApimoPartner, ApimoRate } from './schemas/agency';
|
|
6
|
+
export type { ApimoCity, ApimoUser, CatalogDefinition, CatalogEntry, CatalogTransformer, LocalizedCatalogTransformer, } from './schemas/common';
|
|
7
|
+
export type { ApimoAgreement, ApimoArea, ApimoComment, ApimoConstruction, ApimoFloor, ApimoHeating, ApimoPicture, ApimoPlot, ApimoPrice, ApimoProperty, ApimoRegulation, ApimoResidence, ApimoSurface, ApimoView, ApimoWater, } from './schemas/property';
|
|
6
8
|
export { DummyCache } from './services/storage/dummy.cache';
|
|
7
9
|
export { FilesystemCache } from './services/storage/filesystem.cache';
|
|
8
10
|
export { MemoryCache } from './services/storage/memory.cache';
|
package/dist/schemas/agency.d.ts
CHANGED
|
@@ -414,3 +414,6 @@ export declare function getAgencySchema(transformer: LocalizedCatalogTransformer
|
|
|
414
414
|
brand?: unknown;
|
|
415
415
|
district?: unknown;
|
|
416
416
|
}>;
|
|
417
|
+
export type ApimoAgency = z.infer<ReturnType<typeof getAgencySchema>>;
|
|
418
|
+
export type ApimoPartner = z.infer<typeof PartnerSchema>;
|
|
419
|
+
export type ApimoRate = z.infer<ReturnType<typeof getRateSchema>>;
|
package/dist/schemas/common.d.ts
CHANGED
|
@@ -151,3 +151,5 @@ export declare function getUserSchema(transformer: LocalizedCatalogTransformer):
|
|
|
151
151
|
stories?: unknown[] | undefined;
|
|
152
152
|
rates?: unknown;
|
|
153
153
|
}>;
|
|
154
|
+
export type ApimoUser = z.infer<ReturnType<typeof getUserSchema>>;
|
|
155
|
+
export type ApimoCity = z.infer<typeof CitySchema>;
|
|
@@ -1498,3 +1498,18 @@ export declare function getPropertySchema(transformer: LocalizedCatalogTransform
|
|
|
1498
1498
|
interagency_comment?: unknown;
|
|
1499
1499
|
status_comment?: unknown;
|
|
1500
1500
|
}>;
|
|
1501
|
+
export type ApimoProperty = z.infer<ReturnType<typeof getPropertySchema>>;
|
|
1502
|
+
export type ApimoRegulation = z.infer<ReturnType<typeof getRegulationSchema>>;
|
|
1503
|
+
export type ApimoConstruction = z.infer<ReturnType<typeof getConstructionSchema>>;
|
|
1504
|
+
export type ApimoFloor = z.infer<ReturnType<typeof getFloorSchema>>;
|
|
1505
|
+
export type ApimoHeating = z.infer<ReturnType<typeof getHeatingSchema>>;
|
|
1506
|
+
export type ApimoWater = z.infer<ReturnType<typeof getWaterSchema>>;
|
|
1507
|
+
export type ApimoPrice = z.infer<ReturnType<typeof getPriceSchema>>;
|
|
1508
|
+
export type ApimoResidence = z.infer<ReturnType<typeof getResidenceSchema>>;
|
|
1509
|
+
export type ApimoView = z.infer<ReturnType<typeof getViewSchema>>;
|
|
1510
|
+
export type ApimoAgreement = z.infer<ReturnType<typeof getAgreementSchema>>;
|
|
1511
|
+
export type ApimoSurface = z.infer<ReturnType<typeof getSurfaceSchema>>;
|
|
1512
|
+
export type ApimoPlot = z.infer<ReturnType<typeof getPlotSchema>>;
|
|
1513
|
+
export type ApimoArea = z.infer<ReturnType<typeof getAreaSchema>>;
|
|
1514
|
+
export type ApimoPicture = z.infer<typeof PictureSchema>;
|
|
1515
|
+
export type ApimoComment = z.infer<typeof CommentSchema>;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "apimo.js",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.4",
|
|
4
4
|
"description": "A wrapper for the Apimo API with catalog caching for building custom Real Estate website using their technologies.",
|
|
5
5
|
"author": "Vitaly Lysen <vitaly@lysen.dev> (https://lysen.dev)",
|
|
6
6
|
"license": "MIT",
|