@reykjavik/webtools 0.0.0 → 0.1.1

package/CHANGELOG.md

@@ -4,8 +4,11 @@
 
 - ... <!-- Add new lines here. -->
 
-## 0.0.0
+## 0.1.0 – 0.1.1
 
-_YYYY-MM-DD_
+_2023-03-24_
 
-- feat: Initial release
+- feat: Initial release with:
+  - HTTP helpers — both generic and Next.js specific
+  - React component + hook to make CookieHub consent easier to use.
+  - React component + custom-ping function for SiteImprove analytics.

package/README.md

@@ -1,11 +1,5 @@
 # @reykjavik/webtools
 
-> **Warning** This repo is still very much WIP. The npm package has **NOT**
-> been published yet.
->
-> See [Project Prep TODO](https://github.com/reykjavikcity/webtools/issues/1)
-> for what's planned
-
 Miscellaneous JavaScript/TypeScript helpers used by Reykjavík City's web dev
 teams.
 

package/esm/http.d.ts

@@ -44,12 +44,12 @@ export declare const HTTP_500_InternalServerError = 500;
 export type HTTP_SUCCESS = typeof HTTP_200_OK | typeof HTTP_201_Created | typeof HTTP_202_Accepted;
 export type HTTP_REDIRECTION = typeof HTTP_301_MovedPermanently | typeof HTTP_302_Found | typeof HTTP_303_SeeOther | typeof HTTP_304_NotModified | typeof HTTP_307_TemporaryRedirect | typeof HTTP_308_PermanentRedirect;
 export type HTTP_NOTMODIFIED = typeof HTTP_304_NotModified;
-export type HTTP_CLIENT_ERROR = typeof HTTP_400_BadRequest | typeof HTTP_401_Unauthorized | typeof HTTP_403_Forbidden | typeof HTTP_404_NotFound | typeof HTTP_410_Gone | typeof HTTP_418_ImATeapot;
+export type HTTP_CLIENT_ERROR = typeof HTTP_400_BadRequest | typeof HTTP_401_Unauthorized | typeof HTTP_403_Forbidden | typeof HTTP_404_NotFound | typeof HTTP_410_Gone;
 export type HTTP_NOT_FOUND = typeof HTTP_400_BadRequest | typeof HTTP_404_NotFound | typeof HTTP_410_Gone;
 export type HTTP_BANNED = typeof HTTP_401_Unauthorized | typeof HTTP_403_Forbidden;
 export type HTTP_SERVER_ERROR = typeof HTTP_500_InternalServerError;
 export type HTTP_ERROR = HTTP_CLIENT_ERROR | HTTP_SERVER_ERROR;
-export type HTTP_STATUS = HTTP_SUCCESS | HTTP_REDIRECTION | HTTP_CLIENT_ERROR | HTTP_SERVER_ERROR;
+export type HTTP_STATUS = HTTP_SUCCESS | HTTP_REDIRECTION | HTTP_CLIENT_ERROR | typeof HTTP_418_ImATeapot | HTTP_SERVER_ERROR;
 type TimeUnit = 's' | 'm' | 'h' | 'd' | 'w';
 type TTL = number | `${number}${TimeUnit}`;
 type TTLKeywords = 'permanent' | 'unset' | 'no-cache';

package/esm/next/http.d.ts

@@ -3,20 +3,20 @@ import React, { FunctionComponent } from 'react';
 import { Cleanup } from '@reykjavik/hanna-utils';
 import { ServerResponse } from 'http';
 import type { AppType } from 'next/app';
-import type { HTTP_ERROR, TTLConfig } from '../http';
+import type { HTTP_418_ImATeapot, HTTP_ERROR, TTLConfig } from '../http';
+type HTTP_ERROR_all = HTTP_ERROR | typeof HTTP_418_ImATeapot;
 export * from '../http';
 type NextContextLike = {
     res: ServerResponse;
 };
 export type ErrorProps = {
-    statusCode: HTTP_ERROR;
-    /** If a HTTP_ERROR code is passed, a default error message is displayed */
+    statusCode: HTTP_ERROR_all;
     message?: string;
 };
 type ErrorizedPageProps<EP extends ErrorProps = ErrorProps> = {
     __error: ErrorProps;
 } & Omit<EP, keyof ErrorProps>;
-type ShowErrorPageFn<EP extends ErrorProps = ErrorProps> = (response: ServerResponse | NextContextLike, error: (ErrorProps extends EP ? HTTP_ERROR : never) | EP, 
+type ShowErrorPageFn<EP extends ErrorProps = ErrorProps> = (response: ServerResponse | NextContextLike, error: (ErrorProps extends EP ? HTTP_ERROR_all : never) | EP, 
 /** Defaults to `"2s"`. Gets forwarded on to the `cacheControl` helper from `@reykjavik/webtools/http` */
 ttl?: TTLConfig) => {
     props: ErrorizedPageProps<EP>;

package/http.d.ts

@@ -44,12 +44,12 @@ export declare const HTTP_500_InternalServerError = 500;
 export type HTTP_SUCCESS = typeof HTTP_200_OK | typeof HTTP_201_Created | typeof HTTP_202_Accepted;
 export type HTTP_REDIRECTION = typeof HTTP_301_MovedPermanently | typeof HTTP_302_Found | typeof HTTP_303_SeeOther | typeof HTTP_304_NotModified | typeof HTTP_307_TemporaryRedirect | typeof HTTP_308_PermanentRedirect;
 export type HTTP_NOTMODIFIED = typeof HTTP_304_NotModified;
-export type HTTP_CLIENT_ERROR = typeof HTTP_400_BadRequest | typeof HTTP_401_Unauthorized | typeof HTTP_403_Forbidden | typeof HTTP_404_NotFound | typeof HTTP_410_Gone | typeof HTTP_418_ImATeapot;
+export type HTTP_CLIENT_ERROR = typeof HTTP_400_BadRequest | typeof HTTP_401_Unauthorized | typeof HTTP_403_Forbidden | typeof HTTP_404_NotFound | typeof HTTP_410_Gone;
 export type HTTP_NOT_FOUND = typeof HTTP_400_BadRequest | typeof HTTP_404_NotFound | typeof HTTP_410_Gone;
 export type HTTP_BANNED = typeof HTTP_401_Unauthorized | typeof HTTP_403_Forbidden;
 export type HTTP_SERVER_ERROR = typeof HTTP_500_InternalServerError;
 export type HTTP_ERROR = HTTP_CLIENT_ERROR | HTTP_SERVER_ERROR;
-export type HTTP_STATUS = HTTP_SUCCESS | HTTP_REDIRECTION | HTTP_CLIENT_ERROR | HTTP_SERVER_ERROR;
+export type HTTP_STATUS = HTTP_SUCCESS | HTTP_REDIRECTION | HTTP_CLIENT_ERROR | typeof HTTP_418_ImATeapot | HTTP_SERVER_ERROR;
 type TimeUnit = 's' | 'm' | 'h' | 'd' | 'w';
 type TTL = number | `${number}${TimeUnit}`;
 type TTLKeywords = 'permanent' | 'unset' | 'no-cache';

package/next/http.d.ts

@@ -3,20 +3,20 @@ import React, { FunctionComponent } from 'react';
 import { Cleanup } from '@reykjavik/hanna-utils';
 import { ServerResponse } from 'http';
 import type { AppType } from 'next/app';
-import type { HTTP_ERROR, TTLConfig } from '../http';
+import type { HTTP_418_ImATeapot, HTTP_ERROR, TTLConfig } from '../http';
+type HTTP_ERROR_all = HTTP_ERROR | typeof HTTP_418_ImATeapot;
 export * from '../http';
 type NextContextLike = {
     res: ServerResponse;
 };
 export type ErrorProps = {
-    statusCode: HTTP_ERROR;
-    /** If a HTTP_ERROR code is passed, a default error message is displayed */
+    statusCode: HTTP_ERROR_all;
     message?: string;
 };
 type ErrorizedPageProps<EP extends ErrorProps = ErrorProps> = {
     __error: ErrorProps;
 } & Omit<EP, keyof ErrorProps>;
-type ShowErrorPageFn<EP extends ErrorProps = ErrorProps> = (response: ServerResponse | NextContextLike, error: (ErrorProps extends EP ? HTTP_ERROR : never) | EP, 
+type ShowErrorPageFn<EP extends ErrorProps = ErrorProps> = (response: ServerResponse | NextContextLike, error: (ErrorProps extends EP ? HTTP_ERROR_all : never) | EP, 
 /** Defaults to `"2s"`. Gets forwarded on to the `cacheControl` helper from `@reykjavik/webtools/http` */
 ttl?: TTLConfig) => {
     props: ErrorizedPageProps<EP>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@reykjavik/webtools",
-	"version": "0.0.0",
+	"version": "0.1.1",
 	"description": "Misc. JS/TS helpers used by Reykjavík City's web dev teams.",
 	"main": "index.js",
 	"repository": "ssh://git@github.com:reykjavikcity/webtools.git",
@@ -23,9 +23,9 @@
 	},
 	"sideEffects": false,
 	"exports": {
-		"./CookieHubConsent.tsx": {
-			"import": "./esm/CookieHubConsent.tsx.js",
-			"require": "./CookieHubConsent.tsx.js"
+		"./CookieHubConsent": {
+			"import": "./esm/CookieHubConsent.js",
+			"require": "./CookieHubConsent.js"
 		},
 		"./http": {
 			"import": "./esm/http.js",
@@ -35,13 +35,13 @@
 			"import": "./esm/index.js",
 			"require": "./index.js"
 		},
-		"./next/http.tsx": {
-			"import": "./esm/next/http.tsx.js",
-			"require": "./next/http.tsx.js"
+		"./next/http": {
+			"import": "./esm/next/http.js",
+			"require": "./next/http.js"
 		},
-		"./next/SiteImprove.tsx": {
-			"import": "./esm/next/SiteImprove.tsx.js",
-			"require": "./next/SiteImprove.tsx.js"
+		"./next/SiteImprove": {
+			"import": "./esm/next/SiteImprove.js",
+			"require": "./next/SiteImprove.js"
 		}
 	}
 }