@matochmat/api-client 1.3.3 → 1.3.4

package/dist/v2/lunchFunctionality.d.ts

@@ -0,0 +1,59 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+import type { ApiV2LunchDishType } from '../v2/lunchDish';
+import type { ApiV2OpeningHourType } from '../v2/openingHour';
+import type { ApiV2RestaurantFunctionalityType } from '../v2/restaurantFunctionalityType';
+/**
+ * Type for the individual array items in v2 of the API for the lunch functionality endpoint.
+ */
+export type ApiV2LunchFunctionalityType = ApiV2RestaurantFunctionalityType & {
+    /**
+     * Controls whether or not the restaurant has bonus stamps active.
+     */
+    bonusStampsActive: boolean;
+    /**
+     * Text entered by the restaurant concerning which-if any-special conditions apply for getting bonus stamps.
+     */
+    bonusStampsConditionsText: string;
+    /**
+     * Date when the restaurant should be displayed as the daily lunch tip.
+     */
+    dailyLunchTipDate: string | null;
+    /**
+     * Date when the restaurant would've been displayed as the daily lunch tip but was intentionally skipped.
+     */
+    dailyLunchTipSkippedDate: string | null;
+    /**
+     * Default lunch menu data.
+     */
+    lunchDefault: ApiV2LunchDishType[];
+    /**
+     * Text shown above the menu to provide generic information not directly related to the dishes themselves.
+     */
+    menuText: string;
+    /**
+     * List of opening hours for the lunch.
+     */
+    openingHourList: {
+        items: ApiV2OpeningHourType[];
+    };
+    /**
+     * Styling (CSS code) for the PDF menus.
+     */
+    pdfStyling: string;
+    /**
+     * Template (HTML code and custom shortcodes) for custom daily PDF menus.
+     */
+    pdfTemplateDaily: string;
+    /**
+     * Template (HTML code and custom shortcodes) for custom weekly PDF menus.
+     */
+    pdfTemplateWeekly: string;
+    /**
+     * Type of PDF menus.
+     */
+    pdfTypeId: number;
+};
+/**
+ * The API response type for lunch functionality.
+ */
+export type ApiV2LunchFunctionalityResponseType = ApiV2BaseResponseType<ApiV2LunchFunctionalityType[], number>;

package/dist/v2/lunchMenu.d.ts

@@ -0,0 +1,34 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+/**
+ * Type for the individual array items in v2 of the API for the non-normalized lunch menu endpoint.
+ */
+export type ApiV2LunchMenuType = {
+    /**
+     * The actual food contents of the lunch menu as a JSON string.
+     */
+    content: string;
+    /**
+     * Keeps track of whether or not the menu is a default menu.
+     */
+    isDefaultMenu: boolean;
+    /**
+     * Timestamp of when the menu was last updated.
+     */
+    lastUpdated: string;
+    /**
+     * ID of the restaurant that the menu belongs to.
+     */
+    restaurantId: number;
+    /**
+     * Week the lunch menu is relevant for.
+     */
+    week: number;
+    /**
+     * Year the lunch menu is relevant for.
+     */
+    year: number;
+};
+/**
+ * The API response type for the non-normalized lunch menus.
+ */
+export type ApiV2LunchMenuResponseType = ApiV2BaseResponseType<ApiV2LunchMenuType[], number>;

package/dist/v2/month.d.ts

@@ -0,0 +1,22 @@
+export type ApiV2MonthType = {
+    /**
+     * Index of the year.
+     */
+    index: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11;
+    /**
+     * Name of the month.
+     */
+    name: 'Januari' | 'Februari' | 'Mars' | 'April' | 'Maj' | 'Juni' | 'Juli' | 'Augusti' | 'September' | 'Oktober' | 'November' | 'December';
+    /**
+     * Number of the year.
+     */
+    number: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
+    /**
+     * Short name.
+     */
+    shortName: 'Jan' | 'Feb' | 'Mar' | 'Apr' | 'Maj' | 'Jun' | 'Jul' | 'Aug' | 'Sep' | 'Okt' | 'Nov' | 'Dec';
+    /**
+     * Machine readable name.
+     */
+    slug: 'januari' | 'februari' | 'mars' | 'april' | 'maj' | 'juni' | 'juli' | 'augusti' | 'september' | 'oktober' | 'november' | 'december';
+};

package/dist/v2/monthSet.d.ts

@@ -0,0 +1,11 @@
+import type { ApiV2MonthType } from '../v2/month';
+export type ApiV2MonthSetType = {
+    /**
+     * Actual month.
+     */
+    actualMonth: ApiV2MonthType;
+    /**
+     * Month for the week. May differ from actual month.
+     */
+    weekMonth: ApiV2MonthType;
+};

package/dist/v2/openingHour.d.ts

@@ -0,0 +1,50 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+/**
+ * Type for the individual array items in v2 of the API for the opening hour endpoint.
+ */
+export type ApiV2OpeningHourType = {
+    /**
+     * Time of day when the restaurant closes.
+     */
+    closingTime: string;
+    /**
+     * String representation of when the entity was created.
+     */
+    created: string;
+    /**
+     * ID of the dinner functionality object the opening hour is relevant for, or null if this specific opening hour os connected to a different object type.
+     */
+    dinnerFunctionalityId: number | null;
+    /**
+     * Unique ID for the entity.
+     */
+    id: number;
+    /**
+     * Day of the week the opening hours are relevant for. This is ISO (not american) weekday number (not index).
+     */
+    isoWeekdayNumber: number;
+    /**
+     * String representation of the last time the entity was updated.
+     */
+    lastUpdated: string;
+    /**
+     * ID of the lunch box functionality object the opening hour is relevant for, or null if this specific opening hour os connected to a different object type.
+     */
+    lunchBoxFunctionalityId: number | null;
+    /**
+     * ID of the lunch functionality object the opening hour is relevant for, or null if this specific opening hour os connected to a different object type.
+     */
+    lunchFunctionalityId: number | null;
+    /**
+     * Whether or not the restaurant is open on this day.
+     */
+    open: boolean;
+    /**
+     * Time of day when the restaurant opens.
+     */
+    openingTime: string;
+};
+/**
+ * The API response type for opening hour items.
+ */
+export type ApiV2OpeningHourResponseType = ApiV2BaseResponseType<ApiV2OpeningHourType[], number>;

package/dist/v2/restaurant.d.ts

@@ -0,0 +1,162 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+import type { ApiV2CateringFunctionalityType } from '../v2/cateringFunctionality';
+import type { ApiV2CrawlingConfigurationType } from '../v2/crawlingConfiguration';
+import type { ApiV2DeliveryInfoType } from '../v2/deliveryInfo';
+import type { ApiV2DinnerFunctionalityType } from '../v2/dinnerFunctionality';
+import type { ApiV2GeodataType } from '../v2/geodata';
+import type { ApiV2LunchBoxFunctionalityType } from '../v2/lunchBoxFunctionality';
+import type { ApiV2LunchFunctionalityType } from '../v2/lunchFunctionality';
+import type { ApiV2RestaurantUploadGroupingType } from '../v2/restaurantUploadGrouping';
+import type { ApiV2TableBookingType } from '../v2/tableBooking';
+import type { ApiV2TakeAwayType } from '../v2/takeAway';
+/**
+ * Type for the individual array items in v2 of the API for the restaurant endpoint.
+ */
+export type ApiV2RestaurantType = {
+    /**
+     * Text that describes the restaurant. Displays on the page to give lunch guests a bit of info and is commonly also used for page metadata.
+     */
+    about: string;
+    /**
+     * String representation of the street address for the restaurant.
+     */
+    address: string;
+    /**
+     *
+     */
+    cateringFunctionality: ApiV2CateringFunctionalityType;
+    /**
+     * City ID determining which city the restaurant belongs to.
+     */
+    cityId: number;
+    /**
+     * A compounded rating collected from different rating sites around the web.
+     */
+    compoundRating: number | null;
+    /**
+     *
+     */
+    crawlingConfiguration: ApiV2CrawlingConfigurationType;
+    /**
+     * String representation of when the restaurant was created.
+     */
+    created: null | string;
+    /**
+     * Customer ID determining which customer the restaurant belongs to.
+     */
+    customerId: number;
+    /**
+     * Delivery information.
+     */
+    deliveryInfo: ApiV2DeliveryInfoType;
+    /**
+     * Background for the restaurant details page header.
+     */
+    detailsPageHeaderBackground: ApiV2RestaurantUploadGroupingType;
+    /**
+     *
+     */
+    dinnerFunctionality: ApiV2DinnerFunctionalityType;
+    /**
+     * Restaurant email. Used only for displaying to lunch guests and not for sending emails from the system.
+     */
+    email: string;
+    /**
+     * URL to the restaurant's Facebook page.
+     */
+    facebook: string;
+    /**
+     * Geodata information to place the restaurant on the map.
+     */
+    geodata: ApiV2GeodataType;
+    /**
+     * Unique entity ID.
+     */
+    id: number;
+    /**
+     * URL to the restaurant's Instagram page.
+     */
+    instagram: string;
+    /**
+     * Keywords to match against when searching. Not actually displayed on the page.
+     */
+    keywords: string;
+    /**
+     * String representation of when the restaurant was last updated.
+     */
+    lastUpdated: string;
+    /**
+     * Background for the restaurant logotype.
+     */
+    logotypeBackground: ApiV2RestaurantUploadGroupingType;
+    /**
+     * Restaurant logotype info for the logotype to display on image backgrounds.
+     */
+    logotypeForImageBackground: ApiV2RestaurantUploadGroupingType;
+    /**
+     * Restaurant logotype info for the logotype to display on white backgrounds.
+     */
+    logotypeForWhiteBackground: ApiV2RestaurantUploadGroupingType;
+    /**
+     *
+     */
+    lunchBoxFunctionality: ApiV2LunchBoxFunctionalityType;
+    /**
+     *
+     */
+    lunchFunctionality: ApiV2LunchFunctionalityType;
+    /**
+     * Name of the restaurant.
+     */
+    name: string;
+    /**
+     * Text shown below or in conjunction with name to convey further information. Useful when two restaurants have the same title but are located in different places or when a restaurant has changed name (for instance "Loremrestaurangen (f.d. Ipsumrestaurangen)").
+     */
+    nameSubtext: string;
+    /**
+     * Obfuscated unique ID. Used for legacy purposes only.
+     * @deprecated Only used for legacy support for apps and third parties. In the long run we may consider removing this.
+     * @see ID is now saved as a plain property.
+     */
+    obfuscatedId: string;
+    /**
+     * Whether or not the restaurant is pending and awaiting approval.
+     */
+    pending: boolean;
+    /**
+     * Phone number to the restaurant.
+     */
+    phone: string;
+    /**
+     * Where the price range of the items the restaurant serves starts at. This is on a scale of 1 to 4.
+     */
+    priceRangeFrom: number | null;
+    /**
+     * Where the price range of the items the restaurant serves ends at. This is on a scale of 1 to 4.
+     */
+    priceRangeTo: number | null;
+    /**
+     * Tags the restaurant is connected to.
+     */
+    restaurantTagIds: number[];
+    /**
+     * Machine readable name of the restaurant.
+     */
+    slug: string;
+    /**
+     * Table booking info for the restaurant.
+     */
+    tableBooking: ApiV2TableBookingType;
+    /**
+     * Take away info for the restaurant.
+     */
+    takeAway: ApiV2TakeAwayType;
+    /**
+     * URL to the restaurant's own website.
+     */
+    website: string;
+};
+/**
+ * The API response type for restaurants.
+ */
+export type ApiV2RestaurantResponseType = ApiV2BaseResponseType<ApiV2RestaurantType[], number>;

package/dist/v2/restaurantFunctionalityType.d.ts

@@ -0,0 +1,25 @@
+/**
+ *
+ */
+export type ApiV2RestaurantFunctionalityType = {
+    /**
+     * String representation of when the entity was created.
+     */
+    created: string;
+    /**
+     * Unique ID for the entity.
+     */
+    id: number;
+    /**
+     * String representation of the last time the entity was updated.
+     */
+    lastUpdated: string;
+    /**
+     * ID of the functionality visibility type for the functionality.
+     */
+    restaurantFunctionalityVisibilityTypeId: 1 | 2 | 3 | 4;
+    /**
+     * Restaurant ID the functionality relates to.
+     */
+    restaurantId: number;
+};

package/dist/v2/restaurantUploadConnection.d.ts

@@ -0,0 +1,19 @@
+import type { ApiV2UploadConnectionType } from '../v2/uploadConnection';
+export type ApiV2RestaurantUploadConnectionType = ApiV2UploadConnectionType & {
+    /**
+     * Background color for the upload.
+     */
+    backgroundColor: string;
+    /**
+     * ID of the restaurant the entity belongs to.
+     */
+    restaurantId: number;
+    /**
+     *
+     */
+    restaurantUploadTypeId: number;
+    /**
+     * Sort order for the connection.
+     */
+    sortOrder: number;
+};

package/dist/v2/restaurantUploadGrouping.d.ts

@@ -0,0 +1,3 @@
+import type { ApiV2RestaurantUploadConnectionType } from '../v2/restaurantUploadConnection';
+import type { ApiV2UploadGroupingType } from '../v2/uploadGrouping';
+export type ApiV2RestaurantUploadGroupingType = ApiV2UploadGroupingType<ApiV2RestaurantUploadConnectionType>;

package/dist/v2/tableBooking.d.ts

@@ -0,0 +1,54 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+/**
+ * Type for the individual array items in v2 of the API for the table booking endpoint.
+ */
+export type ApiV2TableBookingType = {
+    /**
+     * Booking link.
+     */
+    bookingLink: string;
+    /**
+     * Text about table booking conditions.
+     */
+    conditionsText: string;
+    /**
+     * Timestamp for when the entity was created.
+     */
+    created: string;
+    /**
+     * Email to use for table booking.
+     */
+    email: string;
+    /**
+     * Unique ID for the entity.
+     */
+    id: number;
+    /**
+     * Link to use for iframe embeds of external table booking systems.
+     */
+    iframeLink: string;
+    /**
+     * Timestamp for when the entity was last updated.
+     */
+    lastUpdated: string;
+    /**
+     * Phone number for booking tables.
+     */
+    phone: string;
+    /**
+     * ID of the restaurant that the table booking info is relevant for.
+     */
+    restaurantId: number;
+    /**
+     * ID of the specific type of table booking that's selected.
+     */
+    tableBookingTypeId: number;
+    /**
+     * Informational text about table booking conditions.
+     */
+    text: string;
+};
+/**
+ * The API response type for table booking info.
+ */
+export type ApiV2TableBookingResponseType = ApiV2BaseResponseType<ApiV2TableBookingType[], number>;

package/dist/v2/takeAway.d.ts

@@ -0,0 +1,46 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+/**
+ * Type for the individual array items in v2 of the API for the take away endpoint.
+ */
+export type ApiV2TakeAwayType = {
+    /**
+     * Timestamp for when the entity was created.
+     */
+    created: string;
+    /**
+     * Email adress to be used for ordering take away.
+     */
+    email: string;
+    /**
+     * Unique ID for the entity.
+     */
+    id: number;
+    /**
+     * Timestamp for when the entity was last updated.
+     */
+    lastUpdated: string;
+    /**
+     * Phone number used for ordering take away.
+     */
+    phone: string;
+    /**
+     * Restaurant ID the entity belongs to.
+     */
+    restaurantId: number;
+    /**
+     * Link to external take away site.
+     */
+    takeAwayLink: string;
+    /**
+     * ID of the specific type of take away that's selected.
+     */
+    takeAwayTypeId: number;
+    /**
+     * Text to display to end users when displaying take away information.
+     */
+    text: string;
+};
+/**
+ * The API response type for take away info.
+ */
+export type ApiV2TakeAwayResponseType = ApiV2BaseResponseType<ApiV2TakeAwayType[], number>;

package/dist/v2/upload.d.ts

@@ -0,0 +1,34 @@
+export type ApiV2UploadType = {
+    /**
+     * Determines whether or not this uses our alternative OG image variant.
+     */
+    alternativeOgImage: boolean;
+    /**
+     * Base name of the file.
+     */
+    baseName: string;
+    /**
+     * File extension.
+     */
+    extension: string;
+    /**
+     * Unique entity ID.
+     */
+    id: number;
+    /**
+     * Timestamp for when entity was last updated.
+     */
+    lastUpdated: string;
+    /**
+     * Factor to use for modifying image max sizes in different parts of the system.
+     */
+    maxSizeFactor: number;
+    /**
+     * Directory path to the file.
+     */
+    path: string;
+    /**
+     * Timestamp for when the image was first uploaded.
+     */
+    uploaded: string;
+};

package/dist/v2/uploadConnection.d.ts

@@ -0,0 +1,18 @@
+export type ApiV2UploadConnectionType = {
+    /**
+     * Timestamp for when the connection was created.
+     */
+    created: string;
+    /**
+     * Unique ID for the entity.
+     */
+    id: number;
+    /**
+     * Timestamp for last update.
+     */
+    lastUpdated: string;
+    /**
+     * ID of the upload.
+     */
+    uploadId: number;
+};

package/dist/v2/uploadGrouping.d.ts

@@ -0,0 +1,11 @@
+import type { ApiV2UploadType } from '../v2/upload';
+export type ApiV2UploadGroupingType<T> = {
+    /**
+     * Upload instance. This represents the actual uploaded file.
+     */
+    upload: ApiV2UploadType;
+    /**
+     * Upload connection. This is the relation entity between the uploaded file and another entity.
+     */
+    uploadConnection: T;
+};

package/dist/v2/version.d.ts

@@ -0,0 +1,31 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+/**
+ * The API response type for backend version info to be compare with client info.
+ */
+export type ApiV2VersionResponseType = ApiV2BaseResponseType<{
+    /**
+     * The semantic version of the latest built package for the version. This generally follows the version of the backend, but may sometimes be left out of sync for backend changes that don't require a new client version to be compiled.
+     */
+    buildSemanticVersion: string;
+    /**
+     * Not relevant for external usage, exists only for in-app comparisons.
+     */
+    buildTime: string;
+    /**
+     * Not relevant for external usage, exists only for in-app comparisons.
+     */
+    buildVersion: string;
+    /**
+     * The version the backend is currently running. Please use this for any eventual comparisons used for checking breaking changes for your API- or client integrations.
+     */
+    packageVersion: string;
+    /**
+     * @deprecated This is from a time before `buildSemanticVersion` and `ApiV2VersionResponseType` existed and you should use one of those instead, most likely what you want is the `packageVersion` specifically.
+     */
+    semanticVersion: string;
+}, number> & {
+    /**
+     * Irrelevant side-effect of generic item count handling for a non-generic endpoint. Can be ignored completely for this specific endpoint.
+     */
+    count: number;
+};

package/dist/v2/week.d.ts

@@ -0,0 +1,34 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+import type { ApiV2DateType } from '../v2/date';
+import type { ApiV2YearSetType } from '../v2/yearSet';
+/**
+ * Type for the non-array data object in v2 of the API for the week endpoint.
+ */
+export type ApiV2WeekType = {
+    /**
+     * List of dates in week.
+     */
+    dates: ApiV2DateType[];
+    /**
+     * Week number.
+     */
+    number: number;
+    /**
+     * Set of current year and week year.
+     */
+    yearSet: ApiV2YearSetType;
+};
+/**
+ * The API response type for week info.
+ */
+export type ApiV2WeekResponseType = ApiV2BaseResponseType<{
+    actual: ApiV2WeekType;
+    crawling: ApiV2WeekType;
+    currentlyShown: ApiV2WeekType;
+    requested: ApiV2WeekType;
+}, number> & {
+    /**
+     * Irrelevant side-effect of generic item count handling for a non-generic endpoint. Can be ignored completely for this specific endpoint.
+     */
+    count: number;
+};

package/dist/v2/year.d.ts

@@ -0,0 +1,22 @@
+export type ApiV2YearType = {
+    /**
+     * Determines whether year is a leap year.
+     */
+    isLeapYear: boolean;
+    /**
+     * Year number.
+     */
+    number: number;
+    /**
+     * Number of weeks this year. This is actually 1 through 53, but I'm not going to write out all options and AFAIK Typescript doesn't yet have built-in helpers for this...
+     */
+    numberOfWeeks: number;
+    /**
+     * Number of weeks next year. This is actually 1 through 53, but I'm not going to write out all options and AFAIK Typescript doesn't yet have built-in helpers for this...
+     */
+    numberOfWeeksNextYear: number;
+    /**
+     * Number of weeks in previous year. This is actually 1 through 53, but I'm not going to write out all options and AFAIK Typescript doesn't yet have built-in helpers for this...
+     */
+    numberOfWeeksPreviousYear: number;
+};

package/dist/v2/yearSet.d.ts

@@ -0,0 +1,11 @@
+import type { ApiV2YearType } from '../v2/year';
+export type ApiV2YearSetType = {
+    /**
+     * Actual number of year.
+     */
+    actualYear: ApiV2YearType;
+    /**
+     * Number of year for the week. May differ from actual year.
+     */
+    weekYear: ApiV2YearType;
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@matochmat/api-client",
   "description": "API types and helper functionality for the Mat och Mat API.",
-  "version": "1.3.3",
+  "version": "1.3.4",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "types": "dist/index.d.ts",
@@ -22,7 +22,7 @@
     "node": ">=20.9"
   },
   "files": [
-    "src"
+    "dist"
   ],
   "devDependencies": {
     "@matochmat/eslint-plugin": "^1.3.0",