,
14 | T extends new (...args: any[]) => DataModelConstructorBuilder
15 | >(
16 | ctor: T
17 | ) =>
18 | class extends ctor {
19 | public query!: Query & IQuery
20 |
21 | public async init() {
22 | if (!this.query) {
23 | const query = Query.create(opts, group)
24 | this.query = query
25 | nonenumerable(this, 'query')
26 | Object.assign(this.params, query)
27 | }
28 | return super.init()
29 | }
30 | }
31 | }
32 |
--------------------------------------------------------------------------------
/packages/model.mixins.query/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@profiscience/knockout-contrib-model-mixins-query",
3 | "version": "1.1.21",
4 | "license": "WTFPL",
5 | "author": "Casey Webb (https://caseyWebb.xyz)",
6 | "homepage": "https://profiscience.github.io/knockout-contrib/packages/model.mixins.query",
7 | "bugs": "https://github.com/Profiscience/knockout-contrib/issues",
8 | "repository": "github:Profiscience/knockout-contrib",
9 | "publishConfig": {
10 | "access": "public"
11 | },
12 | "main": "dist/node/index.js",
13 | "module": "dist/default/index.js",
14 | "esnext": "dist/esnext/index.js",
15 | "types": "index.ts",
16 | "sideEffects": false,
17 | "peerDependencies": {
18 | "@profiscience/knockout-contrib-model-builders-data": ">=2.0.0",
19 | "@profiscience/knockout-contrib-query": ">=2.0.0",
20 | "knockout": "3.5.1"
21 | },
22 | "dependencies": {
23 | "babel-runtime": "^6.26.0"
24 | },
25 | "devDependencies": {
26 | "@profiscience/knockout-contrib-model-builders-data": "^2.3.11",
27 | "@profiscience/knockout-contrib-query": "^2.1.8"
28 | }
29 | }
30 |
--------------------------------------------------------------------------------
/packages/model.mixins.subscriptionDisposal/README.md:
--------------------------------------------------------------------------------
1 | # @profiscience/knockout-contrib-model-mixins-subscription-disposal
2 |
3 | @TODO
4 |
5 | > In the meantime, see the [tests](./test.ts) and [example usage](https://github.com/caseyWebb/knockout-realworld).
6 |
--------------------------------------------------------------------------------
/packages/model.mixins.subscriptionDisposal/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@profiscience/knockout-contrib-model-mixins-subscription-disposal",
3 | "version": "2.1.0",
4 | "license": "WTFPL",
5 | "author": "Casey Webb (https://caseyWebb.xyz)",
6 | "homepage": "https://profiscience.github.io/knockout-contrib/packages/model.mixins.subscriptionDisposal",
7 | "bugs": "https://github.com/Profiscience/knockout-contrib/issues",
8 | "repository": "github:Profiscience/knockout-contrib",
9 | "publishConfig": {
10 | "access": "public"
11 | },
12 | "main": "dist/node/index.js",
13 | "module": "dist/default/index.js",
14 | "esnext": "dist/esnext/index.js",
15 | "types": "index.ts",
16 | "sideEffects": false,
17 | "peerDependencies": {
18 | "knockout": "3.5.1"
19 | },
20 | "dependencies": {
21 | "@profiscience/knockout-contrib-model-builders-base": "^2.0.1",
22 | "babel-runtime": "^6.26.0"
23 | }
24 | }
25 |
--------------------------------------------------------------------------------
/packages/model.mixins.transform/README.md:
--------------------------------------------------------------------------------
1 | # @profiscience/knockout-contrib-model-mixins-transform
2 |
3 | @TODO
4 |
5 | > In the meantime, see the [tests](./test.ts) and [example usage](https://github.com/caseyWebb/knockout-realworld).
6 |
--------------------------------------------------------------------------------
/packages/model.mixins.transform/index.ts:
--------------------------------------------------------------------------------
1 | import { DataModelConstructorBuilder } from '@profiscience/knockout-contrib-model-builders-data'
2 |
3 | export function TransformMixin<
4 | TParams extends void | Record,
5 | TData extends Record
6 | >(transform: (fetchData: TData, params: TParams) => any) {
7 | return <
8 | T extends new (...args: any[]) => DataModelConstructorBuilder<
9 | TParams,
10 | TData
11 | >
12 | >(
13 | ctor: T
14 | ) =>
15 | class extends ctor {
16 | protected async fetch(initData?: TData) {
17 | return transform(await super.fetch(initData), this.params)
18 | }
19 | }
20 | }
21 |
--------------------------------------------------------------------------------
/packages/model.mixins.transform/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@profiscience/knockout-contrib-model-mixins-transform",
3 | "version": "2.1.11",
4 | "license": "WTFPL",
5 | "author": "Casey Webb (https://caseyWebb.xyz)",
6 | "homepage": "https://profiscience.github.io/knockout-contrib/packages/model.mixins.transform",
7 | "bugs": "https://github.com/Profiscience/knockout-contrib/issues",
8 | "repository": "github:Profiscience/knockout-contrib",
9 | "publishConfig": {
10 | "access": "public"
11 | },
12 | "main": "dist/node/index.js",
13 | "module": "dist/default/index.js",
14 | "esnext": "dist/esnext/index.js",
15 | "types": "index.ts",
16 | "sideEffects": false,
17 | "peerDependencies": {
18 | "@profiscience/knockout-contrib-model-builders-data": ">=2.0.0",
19 | "knockout": "3.5.1"
20 | },
21 | "dependencies": {
22 | "babel-runtime": "^6.26.0"
23 | },
24 | "devDependencies": {
25 | "@profiscience/knockout-contrib-model-builders-data": "^2.3.11"
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/packages/model.mixins.transform/test.ts:
--------------------------------------------------------------------------------
1 | // tslint:disable max-classes-per-file
2 |
3 | import * as ko from 'knockout'
4 | import { DataModelConstructorBuilder } from '@profiscience/knockout-contrib-model-builders-data'
5 |
6 | import { TransformMixin } from './index'
7 |
8 | const FOOS = ['foo', 'bar', 'baz', 'qux']
9 |
10 | function reverse(arr: any[]) {
11 | // Array.prototype.reverse() modifies arrays in place b/c JS is stupid,
12 | // so clone and reverse the clone
13 | const tmp = [...arr]
14 | tmp.reverse()
15 | return tmp
16 | }
17 |
18 | function FoosMixin<
19 | P extends { page: number },
20 | T extends new (...args: any[]) => DataModelConstructorBuilder
21 | >(ctor: T) {
22 | return class extends ctor {
23 | public foos = ko.observableArray()
24 | protected async fetch(): Promise {
25 | return {
26 | foos: FOOS,
27 | }
28 | }
29 | }
30 | }
31 | describe('model.mixins.transform', () => {
32 | test('transforms the response from mixed in fetch', async () => {
33 | const reverseFoos = (obj: any) => ({ ...obj, foos: reverse(obj.foos) })
34 | const ReverseFoosMixin = TransformMixin(reverseFoos) // tslint:disable-line variable-name
35 | class DataModel extends DataModelConstructorBuilder.Mixin(
36 | FoosMixin
37 | ).Mixin(ReverseFoosMixin)
{}
38 |
39 | const model = await DataModel.create({})
40 |
41 | expect(ko.toJS(model.foos())).toEqual(reverse(FOOS))
42 |
43 | model.dispose()
44 | })
45 |
46 | test('transforms initData', async () => {
47 | const reverseFoos = (obj: any) => ({ ...obj, foos: reverse(obj.foos) })
48 | const ReverseFoosMixin = TransformMixin(reverseFoos) // tslint:disable-line variable-name
49 | class DataModel
extends DataModelConstructorBuilder.Mixin(
50 | ReverseFoosMixin
51 | )
{
52 | public foos = ko.observableArray()
53 | }
54 |
55 | const model = await DataModel.create({}, { foos: FOOS })
56 |
57 | expect(ko.toJS(model.foos())).toEqual(reverse(FOOS))
58 |
59 | model.dispose()
60 | })
61 | })
62 |
--------------------------------------------------------------------------------
/packages/query/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@profiscience/knockout-contrib-query",
3 | "version": "2.1.8",
4 | "license": "WTFPL",
5 | "author": "Casey Webb (https://caseyWebb.xyz)",
6 | "homepage": "https://profiscience.github.io/knockout-contrib/packages/query",
7 | "bugs": "https://github.com/Profiscience/knockout-contrib/issues",
8 | "repository": "github:Profiscience/knockout-contrib",
9 | "publishConfig": {
10 | "access": "public"
11 | },
12 | "main": "dist/node/index.js",
13 | "module": "dist/default/index.js",
14 | "esnext": "dist/esnext/index.js",
15 | "types": "src/index.ts",
16 | "sideEffects": false,
17 | "peerDependencies": {
18 | "knockout": "3.5.1"
19 | },
20 | "dependencies": {
21 | "babel-runtime": "^6.26.0"
22 | }
23 | }
24 |
--------------------------------------------------------------------------------
/packages/query/src/utils.ts:
--------------------------------------------------------------------------------
1 | export type Primitive = string | boolean | number | null | undefined
2 | export type MaybeArray = T | T[]
3 |
4 | export function isBool(x: any) {
5 | return typeof x === 'boolean'
6 | }
7 |
8 | export function isEmpty(x: any) {
9 | return x.length === 0
10 | }
11 |
12 | export function isNumber(x: any) {
13 | return !isNaN(parseFloat(x))
14 | }
15 |
16 | export function isUndefined(x: any) {
17 | return typeof x === 'undefined'
18 | }
19 |
20 | export function entries(obj: { [k: string]: any }) {
21 | return Object.keys(obj).map((k) => [k, obj[k]])
22 | }
23 |
24 | export function omit(
25 | obj: { [k: string]: any },
26 | fn: (x: any) => boolean | void
27 | ) {
28 | const ret = {} as { [k: string]: any }
29 | for (const [k, v] of entries(obj)) {
30 | if (!fn(v)) {
31 | ret[k] = v
32 | }
33 | }
34 | return ret
35 | }
36 |
--------------------------------------------------------------------------------
/packages/router.middleware.flashMessage/index.ts:
--------------------------------------------------------------------------------
1 | import * as ko from 'knockout'
2 | import { LifecycleMiddleware } from '@profiscience/knockout-contrib-router'
3 |
4 | export const FLASH_MESSAGE = Symbol('FLASH_MESSAGE')
5 |
6 | // tslint:disable-next-line no-empty-interface
7 | export interface IFlashMessage {}
8 |
9 | declare module '@profiscience/knockout-contrib-router' {
10 | // tslint:disable-next-line no-shadowed-variable
11 | interface IContext {
12 | [FLASH_MESSAGE]?: boolean | string | IFlashMessage
13 | }
14 | }
15 |
16 | export const flashMessage: ko.Observable<
17 | boolean | string | IFlashMessage | undefined
18 | > = ko.observable(false)
19 |
20 | export const flashMessageMiddleware: LifecycleMiddleware = (ctx) => ({
21 | afterRender() {
22 | if (ctx[FLASH_MESSAGE]) flashMessage(ctx[FLASH_MESSAGE])
23 | },
24 | afterDispose() {
25 | flashMessage(false)
26 | },
27 | })
28 |
--------------------------------------------------------------------------------
/packages/router.middleware.flashMessage/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@profiscience/knockout-contrib-router-middleware-flash-message",
3 | "version": "2.0.17",
4 | "license": "WTFPL",
5 | "author": "Casey Webb (https://caseyWebb.xyz)",
6 | "homepage": "https://profiscience.github.io/knockout-contrib/packages/router.middleware.flashMessage",
7 | "bugs": "https://github.com/Profiscience/knockout-contrib/issues",
8 | "repository": "github:Profiscience/knockout-contrib",
9 | "publishConfig": {
10 | "access": "public"
11 | },
12 | "main": "dist/node/index.js",
13 | "module": "dist/default/index.js",
14 | "esnext": "dist/esnext/index.js",
15 | "types": "index.ts",
16 | "sideEffects": false,
17 | "peerDependencies": {
18 | "@profiscience/knockout-contrib-router": ">=2.0.0",
19 | "knockout": "3.5.1"
20 | },
21 | "devDependencies": {
22 | "@profiscience/knockout-contrib-router": "^2.1.5"
23 | },
24 | "dependencies": {
25 | "babel-runtime": "^6.26.0"
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/packages/router.middleware.flashMessage/test.ts:
--------------------------------------------------------------------------------
1 | import { Context, IContext } from '@profiscience/knockout-contrib-router'
2 | import {
3 | IFlashMessage,
4 | FLASH_MESSAGE,
5 | flashMessageMiddleware,
6 | flashMessage,
7 | } from './index'
8 |
9 | declare module './index' {
10 | // tslint:disable-next-line no-shadowed-variable
11 | interface IFlashMessage {
12 | text: string
13 | }
14 | }
15 |
16 | describe('router.middleware.flashMessage', () => {
17 | test('sets flashMessage after render', () => {
18 | const expected = 'This is a flash message'
19 | const ctx: Context & IContext = { [FLASH_MESSAGE]: expected } as Context &
20 | IContext
21 | const lifecycle = flashMessageMiddleware(ctx) as any
22 |
23 | expect(lifecycle.beforeRender).toBeUndefined()
24 | expect(flashMessage()).toBe(false)
25 |
26 | lifecycle.afterRender()
27 | expect(flashMessage()).toBe(expected)
28 |
29 | expect(lifecycle.beforeDispose).toBeUndefined()
30 | expect(flashMessage()).toBe(expected)
31 |
32 | lifecycle.afterDispose()
33 | expect(flashMessage()).toBe(false)
34 | })
35 |
36 | test('works with custom flash message format', () => {
37 | const expected: IFlashMessage = { text: 'This is a flash message' }
38 | const ctx: Context & IContext = { [FLASH_MESSAGE]: expected } as Context &
39 | IContext
40 | const lifecycle = flashMessageMiddleware(ctx) as any
41 |
42 | lifecycle.afterRender()
43 | expect(flashMessage()).toEqual(expected)
44 |
45 | lifecycle.afterDispose()
46 | expect(flashMessage()).toBe(false)
47 | })
48 |
49 | test("doesn't blow up when not used", () => {
50 | const ctx = {} as Context & IContext
51 | const lifecycle = flashMessageMiddleware(ctx) as any
52 |
53 | expect(() => {
54 | lifecycle.afterRender()
55 | lifecycle.afterDispose()
56 | }).not.toThrow()
57 | })
58 | })
59 |
--------------------------------------------------------------------------------
/packages/router.middleware.loading/README.md:
--------------------------------------------------------------------------------
1 | # router.middleware.loading
2 |
3 | [![Version][npm-version-shield]][npm]
4 | [![Dependency Status][david-dm-shield]][david-dm]
5 | [![Peer Dependency Status][david-dm-peer-shield]][david-dm-peer]
6 | [![Dev Dependency Status][david-dm-dev-shield]][david-dm-dev]
7 | [![Downloads][npm-stats-shield]][npm-stats]
8 |
9 | [david-dm]: https://david-dm.org/Profiscience/knockout-contrib?path=packages/router.middleware.loading
10 | [david-dm-shield]: https://david-dm.org/Profiscience/knockout-contrib/status.svg?path=packages/router.middleware.loading
11 | [david-dm-peer]: https://david-dm.org/Profiscience/knockout-contrib?path=packages/router.middleware.loading&type=peer
12 | [david-dm-peer-shield]: https://david-dm.org/Profiscience/knockout-contrib/peer-status.svg?path=packages/router.middleware.loading
13 | [david-dm-dev]: https://david-dm.org/Profiscience/knockout-contrib?path=packages/router.middleware.loading&type=dev
14 | [david-dm-dev-shield]: https://david-dm.org/Profiscience/knockout-contrib/dev-status.svg?path=packages/router.middleware.loading
15 | [npm]: https://www.npmjs.com/package/@profiscience/knockout-contrib-router-middleware-loading
16 | [npm-version-shield]: https://img.shields.io/npm/v/@profiscience/knockout-contrib-router-middleware-loading.svg
17 | [npm-stats]: http://npm-stat.com/charts.html?package=@profiscience/knockout-contrib-router-middleware-loading&author=&from=&to=
18 | [npm-stats-shield]: https://img.shields.io/npm/dt/@profiscience/knockout-contrib-router-middleware-loading.svg?maxAge=2592000
19 |
20 | > **NOTE:** This package is intended for consumption via the [@profiscience/knockout-contrib metapackage](../_)
21 |
22 | Eases creation of loading middlware
23 |
24 | ## Usage
25 |
26 | ```typescript
27 | import { Router, createLoadingMiddleware } from '@profiscience/knockout-contrib'
28 |
29 | Router.use(
30 | createLoadingMiddleware({
31 | start() {
32 | showLoader()
33 | },
34 | end() {
35 | hideLoader()
36 | },
37 |
38 | /* OPTIONAL */
39 | minDuration: 0, // prevent flickering on fast navigation (show loader for at least ms)
40 | })
41 | )
42 | ```
43 |
--------------------------------------------------------------------------------
/packages/router.middleware.loading/index.ts:
--------------------------------------------------------------------------------
1 | import {
2 | Context,
3 | IContext,
4 | LifecycleMiddleware,
5 | } from '@profiscience/knockout-contrib-router'
6 |
7 | let startTime = Date.now()
8 |
9 | export function createLoadingMiddleware({
10 | start,
11 | end,
12 | minDuration,
13 | }: {
14 | start: (ctx: Context & IContext) => any
15 | end: (ctx: Context & IContext) => any
16 | minDuration?: number
17 | }): LifecycleMiddleware {
18 | let i = 0
19 | return (ctx: Context & IContext) => ({
20 | beforeRender() {
21 | if (i++ === 0) {
22 | startTime = Date.now()
23 | start(ctx)
24 | }
25 | },
26 | afterRender() {
27 | if (--i === 0) {
28 | if (minDuration) {
29 | const elapsed = Date.now() - startTime
30 | const delay = minDuration - elapsed
31 | // negative delay will be called immediately
32 | setTimeout(() => end(ctx), delay)
33 | } else {
34 | end(ctx)
35 | }
36 | }
37 | },
38 | })
39 | }
40 |
--------------------------------------------------------------------------------
/packages/router.middleware.loading/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@profiscience/knockout-contrib-router-middleware-loading",
3 | "version": "1.0.18",
4 | "license": "WTFPL",
5 | "author": "Casey Webb (https://caseyWebb.xyz)",
6 | "homepage": "https://profiscience.github.io/knockout-contrib/packages/router.middleware.loading",
7 | "bugs": "https://github.com/Profiscience/knockout-contrib/issues",
8 | "repository": "github:Profiscience/knockout-contrib",
9 | "publishConfig": {
10 | "access": "public"
11 | },
12 | "main": "dist/node/index.js",
13 | "module": "dist/default/index.js",
14 | "esnext": "dist/esnext/index.js",
15 | "types": "index.ts",
16 | "sideEffects": false,
17 | "peerDependencies": {
18 | "@profiscience/knockout-contrib-router": ">=2.0.0",
19 | "knockout": "3.5.1"
20 | },
21 | "dependencies": {
22 | "babel-runtime": "^6.26.0"
23 | },
24 | "devDependencies": {
25 | "@profiscience/knockout-contrib-router": "^2.1.5"
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/packages/router.middleware.progressBar/README.md:
--------------------------------------------------------------------------------
1 | # router.middleware.progressBar
2 |
3 | [![Version][npm-version-shield]][npm]
4 | [![Dependency Status][david-dm-shield]][david-dm]
5 | [![Peer Dependency Status][david-dm-peer-shield]][david-dm-peer]
6 | [![Dev Dependency Status][david-dm-dev-shield]][david-dm-dev]
7 | [![Downloads][npm-stats-shield]][npm-stats]
8 |
9 | [david-dm]: https://david-dm.org/Profiscience/knockout-contrib?path=packages/router.middleware.progressBar
10 | [david-dm-shield]: https://david-dm.org/Profiscience/knockout-contrib/status.svg?path=packages/router.middleware.progressBar
11 | [david-dm-peer]: https://david-dm.org/Profiscience/knockout-contrib?path=packages/router.middleware.progressBar&type=peer
12 | [david-dm-peer-shield]: https://david-dm.org/Profiscience/knockout-contrib/peer-status.svg?path=packages/router.middleware.progressBar
13 | [david-dm-dev]: https://david-dm.org/Profiscience/knockout-contrib?path=packages/router.middleware.progressBar&type=dev
14 | [david-dm-dev-shield]: https://david-dm.org/Profiscience/knockout-contrib/dev-status.svg?path=packages/router.middleware.progressBar
15 | [npm]: https://www.npmjs.com/package/@profiscience/knockout-contrib-router-middleware-progress-bar
16 | [npm-version-shield]: https://img.shields.io/npm/v/@profiscience/knockout-contrib-router-middleware-progress-bar.svg
17 | [npm-stats]: http://npm-stat.com/charts.html?package=@profiscience/knockout-contrib-router-middleware-progress-bar&author=&from=&to=
18 | [npm-stats-shield]: https://img.shields.io/npm/dt/@profiscience/knockout-contrib-router-middleware-progress-bar.svg?maxAge=2592000
19 |
20 | > **NOTE:** This package is intended for consumption via the [@profiscience/knockout-contrib metapackage](../_)
21 |
22 | Displays a progress bar using [toprogress2][] during navigation. Accepts all toprogress2 options.
23 |
24 | ## Usage
25 |
26 | ```typescript
27 | import {
28 | Router,
29 | createProgressBarMiddleware,
30 | } from '@profiscience/knockout-contrib'
31 |
32 | Router.use(
33 | createProgressBarMiddleware({
34 | color: '#fff',
35 | height: '5px',
36 | // ... any toprogress2 option
37 | })
38 | )
39 | ```
40 |
--------------------------------------------------------------------------------
/packages/router.middleware.progressBar/examples/index.html:
--------------------------------------------------------------------------------
1 | Instant
19 | 200ms
20 | 400ms
21 | 2s
22 | 5s
23 | 10s
24 | `,
25 | })
26 |
27 | // Use `view` component for all routes
28 | Route.usePlugin(() => 'view')
29 |
30 | // for simulating ajax, indexeddb, etc. delay
31 | Route.usePlugin(({ delay }) => () =>
32 | new Promise((resolve) => setTimeout(resolve, delay))
33 | )
34 |
35 | Router.use(createProgressBarMiddleware())
36 |
37 | Router.useRoutes([
38 | new Route('/', 'view'),
39 | new Route('/200ms', { delay: 200 }),
40 | new Route('/400ms', { delay: 400 }),
41 | new Route('/2s', { delay: 2000 }),
42 | new Route('/5s', { delay: 5000 }),
43 | new Route('/10s', { delay: 10000 }),
44 | ])
45 |
46 | ko.applyBindings()
47 |
--------------------------------------------------------------------------------
/packages/router.middleware.progressBar/index.ts:
--------------------------------------------------------------------------------
1 | import { ToProgress, ToProgressOptions } from 'toprogress2'
2 | import { LifecycleMiddleware } from '@profiscience/knockout-contrib-router'
3 | import { createLoadingMiddleware } from '@profiscience/knockout-contrib-router-middleware-loading'
4 |
5 | export function createProgressBarMiddleware(
6 | opts?: ToProgressOptions
7 | ): LifecycleMiddleware {
8 | const progressBar = new ToProgress(opts)
9 |
10 | return createLoadingMiddleware({
11 | start: () =>
12 | progressBar.start().catch(() => {
13 | /* noop */
14 | }),
15 | end: () =>
16 | progressBar.finish().catch(() => {
17 | /* noop */
18 | }),
19 | })
20 | }
21 |
--------------------------------------------------------------------------------
/packages/router.middleware.progressBar/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@profiscience/knockout-contrib-router-middleware-progress-bar",
3 | "version": "2.0.17",
4 | "license": "WTFPL",
5 | "author": "Casey Webb (https://caseyWebb.xyz)",
6 | "homepage": "https://profiscience.github.io/knockout-contrib/packages/router.middleware.progressBar",
7 | "bugs": "https://github.com/Profiscience/knockout-contrib/issues",
8 | "repository": "github:Profiscience/knockout-contrib",
9 | "publishConfig": {
10 | "access": "public"
11 | },
12 | "main": "dist/node/index.js",
13 | "module": "dist/default/index.js",
14 | "esnext": "dist/esnext/index.js",
15 | "types": "index.ts",
16 | "sideEffects": false,
17 | "peerDependencies": {
18 | "@profiscience/knockout-contrib-router": ">=2.0.0",
19 | "knockout": "3.5.1"
20 | },
21 | "dependencies": {
22 | "@profiscience/knockout-contrib-router-middleware-loading": "^1.0.18",
23 | "babel-runtime": "^6.26.0",
24 | "toprogress2": "^2.0.0"
25 | },
26 | "devDependencies": {
27 | "@profiscience/knockout-contrib-router": "^2.1.5"
28 | }
29 | }
30 |
--------------------------------------------------------------------------------
/packages/router.middleware.progressBar/test.ts:
--------------------------------------------------------------------------------
1 | import * as ToProgress from 'toprogress2'
2 | import { Context, IContext } from '@profiscience/knockout-contrib-router'
3 | import { createProgressBarMiddleware } from './index'
4 |
5 | beforeEach(() => {
6 | ;(ToProgress as any).reset()
7 | })
8 |
9 | describe('router.middleware.progressBar', () => {
10 | test('passes options to toprogress2', () => {
11 | const ctx: Context & IContext = { router: {} } as Context & IContext
12 | const opts = { color: '#fff' }
13 | const lifecycle = createProgressBarMiddleware(opts)(ctx) as any
14 | lifecycle.beforeRender()
15 | expect((ToProgress as any).initializedWith()).toBe(opts)
16 | })
17 | test('starts progress bar before render at most once', () => {
18 | const topCtx: Context & IContext = {
19 | $child: {},
20 | router: {
21 | isRoot: true,
22 | },
23 | } as Context & IContext
24 | const bottomCtx: Context & IContext = {
25 | router: {
26 | isRoot: false,
27 | },
28 | $child: undefined,
29 | } as any
30 | const middleware = createProgressBarMiddleware()
31 | const topLifecycle = middleware(topCtx) as any
32 | const bottomLifecycle = middleware(bottomCtx) as any
33 | topLifecycle.beforeRender()
34 | bottomLifecycle.beforeRender()
35 | expect((ToProgress as any).start).toHaveBeenCalledTimes(1)
36 | })
37 | test('starts progress bar after render at most once', () => {
38 | const topCtx: Context & IContext = {
39 | $child: {},
40 | router: {
41 | isRoot: true,
42 | },
43 | } as Context & IContext
44 | const bottomCtx: Context & IContext = {
45 | router: {
46 | isRoot: false,
47 | },
48 | $child: undefined,
49 | } as any
50 | const middleware = createProgressBarMiddleware()
51 | const topLifecycle = middleware(topCtx) as any
52 | const bottomLifecycle = middleware(bottomCtx) as any
53 | topLifecycle.beforeRender()
54 | bottomLifecycle.beforeRender()
55 | topLifecycle.afterRender()
56 | bottomLifecycle.afterRender()
57 | expect((ToProgress as any).finish).toHaveBeenCalledTimes(1)
58 | })
59 | })
60 |
--------------------------------------------------------------------------------
/packages/router.middleware.scrollPosition/README.md:
--------------------------------------------------------------------------------
1 | # router.middleware.scrollPosition
2 |
3 | [![Version][npm-version-shield]][npm]
4 | [![Dependency Status][david-dm-shield]][david-dm]
5 | [![Peer Dependency Status][david-dm-peer-shield]][david-dm-peer]
6 | [![Dev Dependency Status][david-dm-dev-shield]][david-dm-dev]
7 | [![Downloads][npm-stats-shield]][npm-stats]
8 |
9 | [david-dm]: https://david-dm.org/Profiscience/knockout-contrib?path=packages/router.middleware.scrollPosition
10 | [david-dm-shield]: https://david-dm.org/Profiscience/knockout-contrib/status.svg?path=packages/router.middleware.scrollPosition
11 | [david-dm-peer]: https://david-dm.org/Profiscience/knockout-contrib?path=packages/router.middleware.scrollPosition&type=peer
12 | [david-dm-peer-shield]: https://david-dm.org/Profiscience/knockout-contrib/peer-status.svg?path=packages/router.middleware.scrollPosition
13 | [david-dm-dev]: https://david-dm.org/Profiscience/knockout-contrib?path=packages/router.middleware.scrollPosition&type=dev
14 | [david-dm-dev-shield]: https://david-dm.org/Profiscience/knockout-contrib/dev-status.svg?path=packages/router.middleware.scrollPosition
15 | [npm]: https://www.npmjs.com/package/@profiscience/knockout-contrib-router-middleware-scroll-position
16 | [npm-version-shield]: https://img.shields.io/npm/v/@profiscience/knockout-contrib-router-middleware-scroll-position.svg
17 | [npm-stats]: http://npm-stat.com/charts.html?package=@profiscience/knockout-contrib-router-middleware-scroll-position&author=&from=&to=
18 | [npm-stats-shield]: https://img.shields.io/npm/dt/@profiscience/knockout-contrib-router-middleware-scroll-position.svg?maxAge=2592000
19 |
20 | Add support for:
21 |
22 | - restoring scroll position on back-button navigation
23 | - scrolling to anchors (#hash), or the top on forward navigation
24 |
25 | ## Usage
26 |
27 | ```typescript
28 | import {
29 | Router,
30 | createScrollPositionMiddleware
31 | } from '@profiscience/knockout-contrib'
32 |
33 | Router.use(
34 | createScrollPositionMiddleware({
35 | // optionally supply a custom scroll function (add smooth scrolling, use Velocity, etc.)
36 | scrollTo(x, y) { ... }
37 | })
38 | )
39 | ```
40 |
--------------------------------------------------------------------------------
/packages/router.middleware.scrollPosition/examples/index.html:
--------------------------------------------------------------------------------
1 |
21 |
22 |
14 | }
15 | }
16 |
17 | export function redirectRoutePlugin({
18 | redirect,
19 | }: IRouteConfig): Middleware | void {
20 | if (!redirect) return
21 |
22 | return async (ctx: Context & IContext) => {
23 | const redirectUrl = await redirect(ctx)
24 | if (redirectUrl) {
25 | ctx.redirect(redirectUrl)
26 | }
27 | }
28 | }
29 |
--------------------------------------------------------------------------------
/packages/router.plugins.redirect/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@profiscience/knockout-contrib-router-plugins-redirect",
3 | "version": "2.0.17",
4 | "license": "WTFPL",
5 | "author": "Casey Webb (https://caseyWebb.xyz)",
6 | "homepage": "https://profiscience.github.io/knockout-contrib/packages/router.plugins.redirect",
7 | "bugs": "https://github.com/Profiscience/knockout-contrib/issues",
8 | "repository": "github:Profiscience/knockout-contrib",
9 | "publishConfig": {
10 | "access": "public"
11 | },
12 | "main": "dist/node/index.js",
13 | "module": "dist/default/index.js",
14 | "esnext": "dist/esnext/index.js",
15 | "types": "index.ts",
16 | "sideEffects": false,
17 | "peerDependencies": {
18 | "@profiscience/knockout-contrib-router": ">=2.0.0",
19 | "knockout": "3.5.1"
20 | },
21 | "devDependencies": {
22 | "@profiscience/knockout-contrib-router": "^2.1.5"
23 | },
24 | "dependencies": {
25 | "babel-runtime": "^6.26.0"
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/packages/router.plugins.title/index.ts:
--------------------------------------------------------------------------------
1 | import {
2 | Context,
3 | IContext,
4 | IRouteConfig,
5 | RoutePlugin,
6 | } from '@profiscience/knockout-contrib-router'
7 |
8 | type MaybePromise = T | Promise
9 |
10 | declare module '@profiscience/knockout-contrib-router' {
11 | // tslint:disable-next-line no-shadowed-variable
12 | interface IRouteConfig {
13 | /**
14 | * Document title for view, can be async or sync accessor function
15 | */
16 | title?: string | ((ctx: Context & IContext) => MaybePromise)
17 | }
18 | }
19 |
20 | export function createTitleRoutePlugin(
21 | compose = (ts: string[]) => ts.join(' | ')
22 | ): RoutePlugin {
23 | const titles: MaybePromise[] = []
24 | let terminalTitledRouteContext: null | (Context & IContext)
25 |
26 | return (routeConfig: IRouteConfig) => {
27 | const titleOrAccessor = routeConfig.title
28 |
29 | if (!titleOrAccessor) return
30 |
31 | return (ctx: Context & IContext) => ({
32 | beforeRender() {
33 | terminalTitledRouteContext = ctx
34 | },
35 | afterRender() {
36 | titles.push(
37 | typeof titleOrAccessor === 'function'
38 | ? titleOrAccessor(ctx)
39 | : titleOrAccessor
40 | )
41 | if (ctx === terminalTitledRouteContext) {
42 | terminalTitledRouteContext = null
43 | ctx.queue(
44 | Promise.all(titles)
45 | .then((ts) => {
46 | document.title = compose(ts)
47 | })
48 | .catch((err) => {
49 | throw new Error(`Error setting title: ${err}`)
50 | })
51 | )
52 | }
53 | },
54 | beforeDispose() {
55 | titles.pop()
56 | },
57 | })
58 | }
59 | }
60 |
--------------------------------------------------------------------------------
/packages/router.plugins.title/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@profiscience/knockout-contrib-router-plugins-title",
3 | "version": "2.0.18",
4 | "license": "WTFPL",
5 | "author": "Casey Webb (https://caseyWebb.xyz)",
6 | "homepage": "https://profiscience.github.io/knockout-contrib/packages/router.plugins.title",
7 | "bugs": "https://github.com/Profiscience/knockout-contrib/issues",
8 | "repository": "github:Profiscience/knockout-contrib",
9 | "publishConfig": {
10 | "access": "public"
11 | },
12 | "main": "dist/node/index.js",
13 | "module": "dist/default/index.js",
14 | "esnext": "dist/esnext/index.js",
15 | "types": "index.ts",
16 | "sideEffects": false,
17 | "peerDependencies": {
18 | "@profiscience/knockout-contrib-router": ">=2.0.0",
19 | "knockout": "3.5.1"
20 | },
21 | "devDependencies": {
22 | "@profiscience/knockout-contrib-router": "^2.1.5"
23 | },
24 | "dependencies": {
25 | "babel-runtime": "^6.26.0"
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/packages/router.plugins.with/index.ts:
--------------------------------------------------------------------------------
1 | import {
2 | Context,
3 | IContext,
4 | IRouteConfig,
5 | } from '@profiscience/knockout-contrib-router'
6 |
7 | type MaybePromise = T | Promise
8 |
9 | declare module '@profiscience/knockout-contrib-router' {
10 | // tslint:disable-next-line no-shadowed-variable
11 | interface IRouteConfig {
12 | /**
13 | * Additional data to extend context with.
14 | *
15 | * Can be used for overriding url params, e.g.
16 | *
17 | * ```typescript
18 | * with: { params: { id: 0 } }
19 | * ```
20 | */
21 | with?:
22 | | Context
23 | | IContext
24 | | ((ctx: Context & IContext) => MaybePromise)
25 | }
26 | }
27 |
28 | export function withRoutePlugin({ with: _with }: IRouteConfig) {
29 | if (!_with) return
30 |
31 | return async (ctx: Context & IContext) => {
32 | let src = _with
33 | if (typeof _with === 'function') {
34 | src = await _with(ctx)
35 | }
36 | Object.assign(ctx, src)
37 | }
38 | }
39 |
--------------------------------------------------------------------------------
/packages/router.plugins.with/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@profiscience/knockout-contrib-router-plugins-with",
3 | "version": "2.0.17",
4 | "license": "WTFPL",
5 | "author": "Casey Webb (https://caseyWebb.xyz)",
6 | "homepage": "https://profiscience.github.io/knockout-contrib/packages/router.plugins.with",
7 | "bugs": "https://github.com/Profiscience/knockout-contrib/issues",
8 | "repository": "github:Profiscience/knockout-contrib",
9 | "publishConfig": {
10 | "access": "public"
11 | },
12 | "main": "dist/node/index.js",
13 | "module": "dist/default/index.js",
14 | "esnext": "dist/esnext/index.js",
15 | "types": "index.ts",
16 | "sideEffects": false,
17 | "peerDependencies": {
18 | "@profiscience/knockout-contrib-router": ">=2.0.0",
19 | "knockout": "3.5.1"
20 | },
21 | "devDependencies": {
22 | "@profiscience/knockout-contrib-router": "^2.1.5"
23 | },
24 | "dependencies": {
25 | "babel-runtime": "^6.26.0"
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/packages/router.plugins.with/test.ts:
--------------------------------------------------------------------------------
1 | import { Context, IContext, Route } from '@profiscience/knockout-contrib-router'
2 | import { withRoutePlugin } from './index'
3 |
4 | const FOO = Symbol('foo')
5 |
6 | declare module '@profiscience/knockout-contrib-router' {
7 | // tslint:disable-next-line no-shadowed-variable
8 | interface IContext {
9 | foo?: string
10 | [FOO]?: string
11 | }
12 | }
13 |
14 | Route.usePlugin(withRoutePlugin)
15 |
16 | describe('router.plugins.with', () => {
17 | test('extends context with object passed to with', () => {
18 | const route = new Route('/', { with: { foo: 'bar' } })
19 | const ctx = { route } as Context & IContext
20 | const [middleware] = route.middleware
21 |
22 | middleware(ctx)
23 |
24 | expect(ctx.foo).toBe('bar')
25 | })
26 |
27 | test('works with sync accessor', async () => {
28 | const route = new Route('/', { with: () => ({ foo: 'bar' }) })
29 | const ctx = { route } as Context & IContext
30 | const [middleware] = route.middleware
31 |
32 | await middleware(ctx)
33 |
34 | expect(ctx.foo).toBe('bar')
35 | })
36 |
37 | test('works with async accessor', async () => {
38 | const route = new Route('/', {
39 | with: () => Promise.resolve({ foo: 'bar' }),
40 | })
41 | const ctx = { route } as Context & IContext
42 | const [middleware] = route.middleware
43 |
44 | await middleware(ctx)
45 |
46 | expect(ctx.foo).toBe('bar')
47 | })
48 |
49 | test('accessor recieves context as argument', async () => {
50 | const accessor = jest.fn(() => ({ foo: 'bar' }))
51 | const route = new Route('/', { with: accessor })
52 | const ctx = { route } as Context & IContext
53 | const [middleware] = route.middleware
54 |
55 | await middleware(ctx)
56 |
57 | expect(accessor).toBeCalledWith(ctx)
58 | })
59 |
60 | test('works with symbol keys', () => {
61 | const route = new Route('/', { with: { [FOO]: 'bar' } })
62 | const ctx = { route } as Context & IContext
63 | const [middleware] = route.middleware
64 |
65 | middleware(ctx)
66 |
67 | expect((ctx as any)[FOO]).toBe('bar')
68 | })
69 |
70 | test("doesn't blow up when not used", () => {
71 | const middleware = withRoutePlugin({})
72 | expect(middleware).toBeUndefined()
73 | })
74 | })
75 |
--------------------------------------------------------------------------------
/packages/router/__tests__/.eslintrc:
--------------------------------------------------------------------------------
1 | {
2 | "parserOptions": {
3 | "sourceType": "module"
4 | }
5 | }
6 |
--------------------------------------------------------------------------------
/packages/router/__tests__/basepath.js:
--------------------------------------------------------------------------------
1 | import ko from 'knockout'
2 | import $ from 'jquery'
3 |
4 | import { Router } from '../'
5 |
6 | ko.components.register('basepath', {
7 | template: `
8 |
' })
50 | }
51 | },
52 | })
53 |
--------------------------------------------------------------------------------
/packages/router/__tests__/force-update.js:
--------------------------------------------------------------------------------
1 | import ko from 'knockout'
2 |
3 | import { Router } from '../'
4 |
5 | ko.components.register('force-update', {
6 | template: '
', viewModel = class {} }
8 | ) => {
9 | if (ko.components.isRegistered(name)) {
10 | ko.components.unregister(name)
11 | ko.components.clearCachedDefinition(name)
12 | }
13 | return _register(name, { template, viewModel })
14 | }
15 |
--------------------------------------------------------------------------------
/packages/router/__tests__/index.js:
--------------------------------------------------------------------------------
1 | import ko from 'knockout'
2 | import $ from 'jquery'
3 | import tape from 'tape'
4 |
5 | import { Router } from '../'
6 |
7 | import './helpers/ko-overwrite-component-registration'
8 |
9 | import './anchor'
10 | import './basepath'
11 | import './bindings'
12 | import './routing'
13 | import './hashbang'
14 | import './history'
15 | import './force-update'
16 | import './with'
17 | import './middleware'
18 | import './queue'
19 | import './redirect'
20 | import './before-navigate-callbacks'
21 | import './element'
22 | import './plugins'
23 | import './preserve-query'
24 | import './preserve-state'
25 |
26 | const tests = [
27 | 'routing',
28 | 'basepath',
29 | 'hashbang',
30 | 'history',
31 | 'force-update',
32 | 'with',
33 | 'anchor',
34 | 'bindings-path',
35 | 'bindings-active-path',
36 | 'middleware',
37 | 'queue',
38 | 'redirect',
39 | 'before-navigate-callbacks',
40 | 'element',
41 | 'plugins',
42 | 'preserve-query',
43 | 'preserve-state',
44 | ]
45 |
46 | class TestRunner {
47 | constructor() {
48 | $('body').append(`
49 |
55 | `)
56 | this.test = ko.observable(null)
57 | this.runTests()
58 | }
59 |
60 | async runTests() {
61 | for (const test of tests) {
62 | await this.runTest(test)
63 | }
64 | }
65 |
66 | async runTest(test) {
67 | history.pushState(null, null, '/')
68 |
69 | return await new Promise((resolve) =>
70 | tape(test, (t) => {
71 | Router.routes = []
72 | this.t = t
73 | this.done = () => {
74 | t.end()
75 | resolve()
76 | }
77 | this.test(test)
78 | })
79 | )
80 | }
81 | }
82 |
83 | ko.applyBindings(new TestRunner())
84 |
--------------------------------------------------------------------------------
/packages/router/__tests__/preserve-query.js:
--------------------------------------------------------------------------------
1 | import ko from 'knockout'
2 |
3 | import { Router } from '../'
4 |
5 | ko.components.register('preserve-query', {
6 | template: '
6 |
7 | Returns computed which is `true` if `path` for `router` is currently active
8 |
9 | #### resolveHref({ router, path })
10 |
11 | Gets an absolute path for `path` on `router`
12 |
13 | #### traversePath(router, path)
14 |
15 | Resolves `path` in relation to `router`
16 |
17 | ###### Local
18 |
19 | '/foo' route to the `/foo` route on `router`
20 |
21 | ###### Absolute
22 |
23 | '//foo' will route to the `/foo` route on `router.$root`
24 |
25 | ###### Relative
26 |
27 | **parent**
28 | '../foo' will route to the `/foo` route on `router.$parent`
29 |
30 | **child**
31 | './foo' will route to the `/foo` route on `router.$child`
32 |
--------------------------------------------------------------------------------
/packages/router/examples/index.html:
--------------------------------------------------------------------------------
1 |
2 | Select an example:
3 |
4 |
9 |
10 |
11 |
12 |
13 |
Refresh the page to select another example
14 |
Check the network pane in the dev tools
2 | bar
2 |
3 | back
6 |
--------------------------------------------------------------------------------
/packages/router/examples/lazy-loading/views/baz/index.ts:
--------------------------------------------------------------------------------
1 | export { default as template } from './template.html'
2 |
--------------------------------------------------------------------------------
/packages/router/examples/lazy-loading/views/baz/template.html:
--------------------------------------------------------------------------------
1 | baz
2 |
3 | back
6 |
--------------------------------------------------------------------------------
/packages/router/examples/lazy-loading/views/foo/index.ts:
--------------------------------------------------------------------------------
1 | export { default as template } from './template.html'
2 |
--------------------------------------------------------------------------------
/packages/router/examples/lazy-loading/views/foo/template.html:
--------------------------------------------------------------------------------
1 | foo
2 |
3 | back
6 |
--------------------------------------------------------------------------------
/packages/router/examples/lazy-loading/views/list/index.ts:
--------------------------------------------------------------------------------
1 | export { default as template } from './template.html'
2 |
--------------------------------------------------------------------------------
/packages/router/examples/lazy-loading/views/list/template.html:
--------------------------------------------------------------------------------
1 | foo
2 | bar
5 | baz
8 | qux
11 | qux
2 |
3 | back
6 |
--------------------------------------------------------------------------------
/packages/router/examples/loading-animation/index.html:
--------------------------------------------------------------------------------
1 |
67 |
68 |
69 |
70 | ●
71 | ●
72 | ●
73 | ●
74 | ●
75 | ●
76 |
77 |
bar
2 |
3 | go to foo
6 |
--------------------------------------------------------------------------------
/packages/router/examples/loading-animation/views/foo/index.ts:
--------------------------------------------------------------------------------
1 | import * as ko from 'knockout'
2 | import template from './template.html'
3 |
4 | ko.components.register('foo', { template })
5 |
--------------------------------------------------------------------------------
/packages/router/examples/loading-animation/views/foo/template.html:
--------------------------------------------------------------------------------
1 | foo
2 |
3 | go to bar
6 |
--------------------------------------------------------------------------------
/packages/router/examples/path-binding/index.html:
--------------------------------------------------------------------------------
1 |
9 |
10 | These paths exist outside any router, so '/' is good
11 | /foo
13 | /bar
14 |
15 | ${foo}
8 |
9 | These begin with '/', so they route using the current (containing) router
10 | /foo
12 | /bar
13 |
14 | ./baz
20 |
21 | //${foo}/qux
27 |
28 | ${foo}
35 |
36 | These begin with '/', so they route using the current (containing) router
37 | /baz
39 | /qux
40 | `
41 | }
42 |
43 | ko.components.register('empty', { template: 'Logout ',
35 | })
36 |
37 | ko.components.register('login', {
38 | viewModel: class {
39 | public login() {
40 | sessionStorage.setItem('authenticated', 'true')
41 | Router.update('/').catch((err) => console.error('Error navigating', err)) // tslint:disable-line no-console
42 | }
43 | },
44 | template: `
45 | Login
46 | Login
47 | `,
48 | })
49 |
50 | ko.components.register('simple-auth', { template })
51 |
--------------------------------------------------------------------------------
/packages/router/examples/transition-animation/index.html:
--------------------------------------------------------------------------------
1 |
6 |
7 | > {
14 | // ctx.element does not exist before render, for obvious reasons.
15 | yield
16 |
17 | // For less obvious reasons, ctx.element is undefined during redirection,
18 | // so we need to add a guard otherwise the following promises will never
19 | // resolve.
20 | if (ctx.element) {
21 | const $el = $(ctx.element)
22 |
23 | yield new Promise((resolve) => $el.fadeIn(resolve))
24 | yield new Promise((resolve) => $el.fadeOut(resolve))
25 | }
26 | }
27 | // This is semantically the same, but uses an async generator (which yields a promise)
28 | // instead of yielding a promise directly
29 | //
30 | // const transitionAnimationMiddleware = async function*(ctx: Context & IContext): AsyncIterableIterator {
31 | // yield
32 |
33 | // if (ctx.element) {
34 | // const $el = $(ctx.element)
35 |
36 | // await new Promise((resolve) => $el.fadeIn(resolve))
37 | // yield
38 |
39 | // await new Promise((resolve) => $el.fadeOut(resolve))
40 | // yield
41 | // }
42 | // }
43 |
44 | Router.use(transitionAnimationMiddleware)
45 |
46 | Router.useRoutes({
47 | '/': (ctx: any) => ctx.redirect('/foo'),
48 | '/foo': 'foo',
49 | '/bar': 'bar',
50 | })
51 |
52 | ko.components.register('foo', {
53 | template: `
54 | foo
55 |
56 | go to bar
59 | `,
60 | })
61 | ko.components.register('bar', {
62 | template: `
63 | bar
64 |
65 | go to foo
68 | `,
69 | })
70 |
71 | ko.components.register('transition-animation', { template })
72 |
--------------------------------------------------------------------------------
/packages/router/karma.conf.js:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env node
2 |
3 | 'use strict'
4 |
5 | const path = require('path')
6 |
7 | const { DEBUG } = process.env
8 |
9 | module.exports = (config) => {
10 | config.set({
11 | basePath: __dirname,
12 |
13 | plugins: [
14 | require('karma-firefox-launcher'),
15 | require('karma-tap-pretty-reporter'),
16 | require('karma-tap'),
17 | require('karma-webpack'),
18 | require('karma-remap-istanbul'),
19 | ],
20 |
21 | frameworks: ['tap'],
22 |
23 | files: ['__tests__/index.js'],
24 |
25 | preprocessors: {
26 | '__tests__/index.js': 'webpack',
27 | },
28 |
29 | browsers: ['_Firefox'],
30 |
31 | browserConsoleLogOptions: {
32 | terminal: false,
33 | },
34 |
35 | customLaunchers: {
36 | _Firefox: {
37 | base: 'Firefox',
38 | flags: ['-private'],
39 | },
40 | },
41 |
42 | // to debug, comment out singleRun, and uncomment autoWatch
43 | singleRun: !DEBUG,
44 | autoWatch: DEBUG,
45 |
46 | reporters: ['tap-pretty', 'karma-remap-istanbul'],
47 |
48 | tapReporter: {
49 | // prettify: require('tap-diff')
50 | },
51 |
52 | remapIstanbulReporter: {
53 | reports: {
54 | lcovonly: 'coverage/lcov.info',
55 | html: 'coverage/html',
56 | },
57 | },
58 |
59 | webpack: {
60 | context: __dirname,
61 | mode: 'development',
62 | node: {
63 | fs: 'empty',
64 | },
65 | devtool: 'inline-source-map',
66 | module: {
67 | rules: [
68 | {
69 | test: /\.js$/,
70 | use: {
71 | loader: 'istanbul-instrumenter-loader',
72 | options: { esModules: true },
73 | },
74 | include: path.resolve('dist'),
75 | },
76 | ],
77 | },
78 | },
79 |
80 | webpackMiddleware: {},
81 | })
82 | }
83 |
--------------------------------------------------------------------------------
/packages/router/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@profiscience/knockout-contrib-router",
3 | "version": "2.1.5",
4 | "license": "WTFPL",
5 | "author": "Casey Webb (https://caseyWebb.xyz)",
6 | "homepage": "https://profiscience.github.io/knockout-contrib/packages/router",
7 | "bugs": "https://github.com/Profiscience/knockout-contrib/issues",
8 | "repository": "github:Profiscience/knockout-contrib",
9 | "publishConfig": {
10 | "access": "public"
11 | },
12 | "scripts": {
13 | "test": "karma start"
14 | },
15 | "main": "dist/node/index.js",
16 | "module": "dist/default/index.js",
17 | "esnext": "dist/esnext/index.js",
18 | "types": "src/index.ts",
19 | "peerDependencies": {
20 | "knockout": "3.5.1"
21 | },
22 | "dependencies": {
23 | "babel-runtime": "^6.26.0",
24 | "path-to-regexp": "^6.0.0"
25 | },
26 | "devDependencies": {
27 | "istanbul-instrumenter-loader": "^3.0.1",
28 | "karma": "^6.0.1",
29 | "karma-firefox-launcher": "^2.0.0",
30 | "karma-remap-istanbul": "^0.6.0",
31 | "karma-tap": "^4.0.0",
32 | "karma-tap-pretty-reporter": "^4.0.0",
33 | "karma-webpack": "^5.0.0",
34 | "tap-diff": "^0.1.1",
35 | "tape": "^5.0.0",
36 | "webpack": "^4.33.0"
37 | }
38 | }
39 |
--------------------------------------------------------------------------------
/packages/router/src/bindings/active-path.ts:
--------------------------------------------------------------------------------
1 | import * as ko from 'knockout'
2 | import { Router } from '../router'
3 | import {
4 | isActivePath,
5 | traversePath,
6 | getRouterForBindingContext,
7 | log,
8 | } from '../utils'
9 |
10 | export const activePathBinding: ko.BindingHandler = {
11 | init(el, valueAccessor, allBindings, viewModel, bindingCtx) {
12 | const activePathCSSClass =
13 | allBindings.get('pathActiveClass') || Router.config.activePathCSSClass
14 | const path = ko.unwrap(valueAccessor())
15 |
16 | Router.initialized
17 | .then(() => {
18 | const router = getRouterForBindingContext(bindingCtx)
19 | const route = ko.pureComputed(() => traversePath(router, path))
20 | ko.applyBindingsToNode(
21 | el,
22 | {
23 | css: {
24 | [activePathCSSClass]: ko.pureComputed(() =>
25 | isActivePath(route())
26 | ),
27 | },
28 | },
29 | bindingCtx
30 | )
31 | })
32 | .catch((err) => log.error('Error initializing activePath binding', err))
33 | },
34 | }
35 |
36 | ko.bindingHandlers.activePath = activePathBinding
37 |
--------------------------------------------------------------------------------
/packages/router/src/bindings/index.ts:
--------------------------------------------------------------------------------
1 | import './path'
2 | import './active-path'
3 |
--------------------------------------------------------------------------------
/packages/router/src/bindings/path.ts:
--------------------------------------------------------------------------------
1 | import * as ko from 'knockout'
2 | import { Router } from '../router'
3 | import {
4 | resolveHref,
5 | traversePath,
6 | getRouterForBindingContext,
7 | log,
8 | } from '../utils'
9 | import { activePathBinding } from './active-path'
10 |
11 | export const pathBinding: ko.BindingHandler = {
12 | init(el, valueAccessor, allBindings, viewModel, bindingCtx) {
13 | ;(activePathBinding.init as any).call(
14 | this,
15 | el,
16 | valueAccessor,
17 | allBindings,
18 | viewModel,
19 | bindingCtx
20 | )
21 |
22 | const path = ko.unwrap(valueAccessor())
23 |
24 | Router.initialized
25 | .then(() => {
26 | const router = getRouterForBindingContext(bindingCtx)
27 | const route = ko.pureComputed(() => traversePath(router, path))
28 | ko.applyBindingsToNode(
29 | el,
30 | {
31 | attr: {
32 | href: ko.pureComputed(() => resolveHref(route())),
33 | },
34 | },
35 | bindingCtx
36 | )
37 | })
38 | .catch((err) => log.error('Error initializing path binding', err))
39 | },
40 | }
41 |
42 | ko.bindingHandlers.path = pathBinding
43 |
--------------------------------------------------------------------------------
/packages/router/src/index.ts:
--------------------------------------------------------------------------------
1 | /* tslint:disable no-empty-interface */
2 |
3 | import './bindings'
4 | import './component'
5 |
6 | export * from './context'
7 | export * from './route'
8 | export * from './router'
9 | export { isActivePath, resolveHref } from './utils'
10 |
11 | /**
12 | * IContext exists for the sole purpose that classes do not support declaration
13 | * merging.
14 | *
15 | * See https://github.com/Microsoft/TypeScript/issues/9532 for why this is here, and
16 | * not ./context.ts where it belongs...
17 | *
18 | * tl;dr, re-exported interfaces can't be declared w/ the top level name, so
19 | * to augment (declaration merging) IContext in consumer code, you'd need to do...
20 | *
21 | * declare module "@profiscience/knockout-contrib-router/dist/typings/context" {
22 | * // ...
23 | * }
24 | *
25 | * and IMO that's just bad; at least way worse than this.
26 | */
27 | export interface IContext {}
28 | export interface IRouteConfig {}
29 |
--------------------------------------------------------------------------------
/packages/utils.assign/index.ts:
--------------------------------------------------------------------------------
1 | import * as ko from 'knockout'
2 | import { fromJS } from '@profiscience/knockout-contrib-utils-from-js'
3 |
4 | export type MergeOptions = {
5 | mapArrayElements?: boolean
6 | strict?: boolean
7 | }
8 |
9 | export function assign<
10 | TSrc extends Record,
11 | TDest extends Record
12 | >(
13 | dest: TDest,
14 | src: TSrc,
15 | opts: MergeOptions = { mapArrayElements: false, strict: false }
16 | ): Record {
17 | const props = Object.keys(src) as (keyof TSrc)[]
18 |
19 | const ret = dest as Record
20 |
21 | for (const prop of props) {
22 | if (isUndefined(ret[prop])) {
23 | if (opts.strict) {
24 | ret[prop] = src[prop]
25 | } else {
26 | ret[prop] = fromJS(
27 | src[prop],
28 | (src[prop] as any) instanceof Array && opts.mapArrayElements
29 | )
30 | }
31 | } else if (ko.isObservable(ret[prop])) {
32 | // skip non-writable computeds
33 | if (!ko.isWriteableObservable(ret[prop])) {
34 | continue
35 | }
36 | ret[prop](
37 | (src[prop] as any) instanceof Array && opts.mapArrayElements
38 | ? ko.unwrap(fromJS(src[prop], true))
39 | : src[prop]
40 | )
41 | } else if (src[prop] && src[prop].constructor === Object) {
42 | // tslint:disable-next-line
43 | if (ret[prop] === null) {
44 | ret[prop] = {}
45 | }
46 | assign(ret[prop], src[prop], opts)
47 | } else {
48 | ret[prop] = src[prop]
49 | }
50 | }
51 |
52 | return ret
53 | }
54 |
55 | function isUndefined(foo: any): boolean {
56 | return typeof foo === 'undefined'
57 | }
58 |
--------------------------------------------------------------------------------
/packages/utils.assign/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@profiscience/knockout-contrib-utils-assign",
3 | "version": "2.0.6",
4 | "license": "WTFPL",
5 | "author": "Casey Webb (https://caseyWebb.xyz)",
6 | "homepage": "https://profiscience.github.io/knockout-contrib/packages/utils.assign",
7 | "bugs": "https://github.com/Profiscience/knockout-contrib/issues",
8 | "repository": "github:Profiscience/knockout-contrib",
9 | "publishConfig": {
10 | "access": "public"
11 | },
12 | "main": "dist/node/index.js",
13 | "module": "dist/default/index.js",
14 | "esnext": "dist/esnext/index.js",
15 | "types": "index.d.ts",
16 | "sideEffects": false,
17 | "peerDependencies": {
18 | "knockout": "3.5.1"
19 | },
20 | "dependencies": {
21 | "@profiscience/knockout-contrib-utils-from-js": "^2.0.4",
22 | "babel-runtime": "^6.26.0"
23 | },
24 | "devDependencies": {
25 | "@profiscience/knockout-contrib-jest-matchers": "^2.0.4"
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/packages/utils.defaults/README.md:
--------------------------------------------------------------------------------
1 | # utils.defaults
2 |
3 | [![Version][npm-version-shield]][npm]
4 | [![Dependency Status][david-dm-shield]][david-dm]
5 | [![Peer Dependency Status][david-dm-peer-shield]][david-dm-peer]
6 | [![Dev Dependency Status][david-dm-dev-shield]][david-dm-dev]
7 | [![Downloads][npm-stats-shield]][npm-stats]
8 |
9 | [david-dm]: https://david-dm.org/Profiscience/knockout-contrib?path=packages/utils.defaults
10 | [david-dm-shield]: https://david-dm.org/Profiscience/knockout-contrib/status.svg?path=packages/utils.defaults
11 | [david-dm-peer]: https://david-dm.org/Profiscience/knockout-contrib?path=packages/utils.defaults&type=peer
12 | [david-dm-peer-shield]: https://david-dm.org/Profiscience/knockout-contrib/peer-status.svg?path=packages/utils.defaults
13 | [david-dm-dev]: https://david-dm.org/Profiscience/knockout-contrib?path=packages/utils.defaults&type=dev
14 | [david-dm-dev-shield]: https://david-dm.org/Profiscience/knockout-contrib/dev-status.svg?path=packages/utils.defaults
15 | [npm]: https://www.npmjs.com/package/@profiscience/knockout-contrib-utils-defaults
16 | [npm-version-shield]: https://img.shields.io/npm/v/@profiscience/knockout-contrib-utils-defaults.svg
17 | [npm-stats]: http://npm-stat.com/charts.html?package=@profiscience/knockout-contrib-utils-defaults&author=&from=&to=
18 | [npm-stats-shield]: https://img.shields.io/npm/dt/@profiscience/knockout-contrib-utils-defaults.svg?maxAge=2592000
19 |
20 | > This package is intended for consumption via the [@profiscience/knockout-contrib] metapackage
21 |
22 | ## Usage
23 |
24 | > defaults(dest, defaultValues[, mapArrays = false])
25 |
26 | Creates observables for enumerable properties of `defaultValues` where undefined in the destination object.
27 |
28 | If `mapArrayElements` is true, array elements will be created using [utils.fromJS](../utils.fromJS).
29 |
30 | ```javascript
31 | import { defaults } from '@profiscience/knockout-contrib'
32 |
33 | const foos = { foo: 'foo' }
34 | defaults(foos, { foo: 'bar', bar: 'bar' })
35 |
36 | foos()
37 | // { foo: 'foo', bar: 'bar' }
38 | ```
39 |
--------------------------------------------------------------------------------
/packages/utils.defaults/index.ts:
--------------------------------------------------------------------------------
1 | import * as ko from 'knockout'
2 | import { fromJS } from '@profiscience/knockout-contrib-utils-from-js'
3 |
4 | export function defaults<
5 | TSrc extends Record,
6 | TDest extends {
7 | [P in keyof TSrc]?: TSrc[P] extends []
8 | ? ko.ObservableArray
9 | : ko.Observable
10 | }
11 | >(dest: TDest, defaultValues: TSrc, mapArraysDeep = false): TDest {
12 | for (const prop in defaultValues) {
13 | if (defaultValues.hasOwnProperty(prop)) {
14 | const maybeDestObservable = dest[prop]
15 | if (isUndefined(maybeDestObservable)) {
16 | dest[prop] = fromJS(
17 | defaultValues[prop],
18 | (defaultValues[prop] as any) instanceof Array && mapArraysDeep
19 | )
20 | } else if (
21 | ko.isObservable(maybeDestObservable) &&
22 | isUndefined(maybeDestObservable())
23 | ) {
24 | maybeDestObservable(defaultValues[prop])
25 | }
26 | }
27 | }
28 | return dest
29 | }
30 |
31 | function isUndefined(foo: any): boolean {
32 | return typeof foo === 'undefined'
33 | }
34 |
--------------------------------------------------------------------------------
/packages/utils.defaults/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@profiscience/knockout-contrib-utils-defaults",
3 | "version": "2.1.4",
4 | "license": "WTFPL",
5 | "author": "Casey Webb (https://caseyWebb.xyz)",
6 | "homepage": "https://profiscience.github.io/knockout-contrib/packages/utils.defaults",
7 | "bugs": "https://github.com/Profiscience/knockout-contrib/issues",
8 | "repository": "github:Profiscience/knockout-contrib",
9 | "publishConfig": {
10 | "access": "public"
11 | },
12 | "main": "dist/node/index.js",
13 | "module": "dist/default/index.js",
14 | "esnext": "dist/esnext/index.js",
15 | "types": "index.d.ts",
16 | "sideEffects": false,
17 | "peerDependencies": {
18 | "knockout": "3.5.1"
19 | },
20 | "dependencies": {
21 | "@profiscience/knockout-contrib-utils-from-js": "^2.0.4",
22 | "babel-runtime": "^6.26.0"
23 | },
24 | "devDependencies": {
25 | "@profiscience/knockout-contrib-jest-matchers": "^2.0.4"
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/packages/utils.defaults/test.ts:
--------------------------------------------------------------------------------
1 | import * as ko from 'knockout'
2 | import '@profiscience/knockout-contrib-jest-matchers'
3 | import { defaults } from './index'
4 |
5 | test('assigns default values', () => {
6 | const actual = {
7 | foo: 'foo',
8 | bar: ko.observable('bar'),
9 | qux: ko.observable(undefined),
10 | } as any
11 |
12 | defaults(actual, {
13 | foo: 'default',
14 | bar: 'default',
15 | baz: 'default',
16 | qux: 'default',
17 | })
18 |
19 | expect(actual.foo).toBe('foo')
20 | expect(actual.bar()).toBe('bar')
21 | expect(actual.baz()).toBe('default')
22 | expect(actual.qux()).toBe('default')
23 | })
24 |
25 | const testArrays = (
26 | mapArraysArg: undefined | boolean | null,
27 | shouldMapArrays: boolean
28 | ) => () => {
29 | const actual: any = {}
30 |
31 | defaults(actual, { foo: ['foo'] }, mapArraysArg as boolean)
32 |
33 | expect(actual.foo).toBeObservable()
34 |
35 | shouldMapArrays
36 | ? expect(actual.foo()[0]).toBeObservable()
37 | : expect(actual.foo()[0]).not.toBeObservable()
38 |
39 | expect(ko.toJS(actual.foo()[0])).toBe('foo')
40 | }
41 |
42 | test(
43 | 'creates shallow arrays when 3rd arg is undefined',
44 | testArrays(undefined, false)
45 | )
46 | test('creates shallow arrays when 3rd arg is falsy', testArrays(null, false))
47 | test('creates shallow arrays when 3rd arg is false', testArrays(false, false))
48 | test('creates deep arrays when 3rd arg is true', testArrays(true, true))
49 |
--------------------------------------------------------------------------------
/packages/utils.fromJS/benchmark.ts:
--------------------------------------------------------------------------------
1 | import * as ko from 'knockout'
2 | import * as benchmark from 'benchmark'
3 | import 'knockout-mapping'
4 | import { padEnd } from 'lodash'
5 | import { fromJS } from './index'
6 |
7 | const obj = {
8 | foo: {
9 | bar: {
10 | baz: {
11 | qux: true,
12 | },
13 | },
14 | },
15 | foos: [{ foo: true }, { bar: true }, { baz: true }, { qux: true }],
16 | }
17 |
18 | const suite = new benchmark.Suite()
19 |
20 | suite
21 | .add(padEnd('utils.fromJS', 40), () => {
22 | fromJS({ ...obj })
23 | })
24 | .add(padEnd('utils.fromJS (mapArrayElements)', 40), () => {
25 | fromJS({ ...obj }, true)
26 | })
27 | .add(padEnd('mapping.fromJS', 40), () => {
28 | ;(ko as any).mapping.fromJS({ ...obj })
29 | })
30 | .on('cycle', (e: any) => {
31 | // tslint:disable:no-console
32 | if (e.target.error) {
33 | console.error(e.target.error)
34 | process.exit(1)
35 | return
36 | }
37 | console.log(e.target.toString())
38 | })
39 | .run()
40 |
--------------------------------------------------------------------------------
/packages/utils.fromJS/index.ts:
--------------------------------------------------------------------------------
1 | import * as ko from 'knockout'
2 |
3 | type ObservableTree = T extends any[]
4 | ? ko.ObservableArray
5 | : T extends Date
6 | ? ko.Observable
7 | : T extends RegExp
8 | ? ko.Observable
9 | : T extends ko.Observable
10 | ? T
11 | : T extends ko.ObservableArray
12 | ? T
13 | : T extends ko.Computed
14 | ? T
15 | : T extends (...args: any[]) => any
16 | ? T
17 | : T extends { [k: string]: any }
18 | ? { readonly [P in keyof T]: ObservableTree }
19 | : ko.Observable
20 |
21 | export function fromJS(obj: T, mapArrayElements = false): ObservableTree {
22 | if (ko.isObservable(obj)) {
23 | return obj as any
24 | } else if (Array.isArray(obj)) {
25 | return ko.observableArray(
26 | mapArrayElements ? obj.map((v) => fromJS(v, mapArrayElements)) : obj
27 | ) as any
28 | } else if (obj instanceof Date || obj instanceof RegExp) {
29 | return ko.observable(obj) as any
30 | } else if (obj instanceof Function) {
31 | return obj as any
32 | } else if (obj instanceof Object) {
33 | const obs = Object.create(Object.getPrototypeOf(obj))
34 | for (const p of Object.keys(obj)) {
35 | obs[p] = fromJS((obj as any)[p], mapArrayElements)
36 | }
37 | return obs
38 | } else {
39 | return ko.observable(obj) as any
40 | }
41 | }
42 |
--------------------------------------------------------------------------------
/packages/utils.fromJS/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@profiscience/knockout-contrib-utils-from-js",
3 | "version": "2.0.4",
4 | "license": "WTFPL",
5 | "author": "Casey Webb (https://caseyWebb.xyz)",
6 | "homepage": "https://profiscience.github.io/knockout-contrib/packages/utils.fromJS",
7 | "bugs": "https://github.com/Profiscience/knockout-contrib/issues",
8 | "repository": "github:Profiscience/knockout-contrib",
9 | "publishConfig": {
10 | "access": "public"
11 | },
12 | "scripts": {
13 | "bench": "ts-node ./benchmark.ts"
14 | },
15 | "main": "dist/node/index.js",
16 | "module": "dist/default/index.js",
17 | "esnext": "dist/esnext/index.js",
18 | "types": "index.d.ts",
19 | "sideEffects": false,
20 | "peerDependencies": {
21 | "knockout": "3.5.1"
22 | },
23 | "devDependencies": {
24 | "@profiscience/knockout-contrib-jest-matchers": "^2.0.4",
25 | "knockout-mapping": "^2.6.0"
26 | },
27 | "dependencies": {
28 | "babel-runtime": "^6.26.0"
29 | }
30 | }
31 |
--------------------------------------------------------------------------------
/packages/utils.increment/README.md:
--------------------------------------------------------------------------------
1 | # utils.increment / utils.decrement
2 |
3 | [![Version][npm-version-shield]][npm]
4 | [![Dependency Status][david-dm-shield]][david-dm]
5 | [![Peer Dependency Status][david-dm-peer-shield]][david-dm-peer]
6 | [![Dev Dependency Status][david-dm-dev-shield]][david-dm-dev]
7 | [![Downloads][npm-stats-shield]][npm-stats]
8 |
9 | [david-dm]: https://david-dm.org/Profiscience/knockout-contrib?path=packages/utils.increment
10 | [david-dm-shield]: https://david-dm.org/Profiscience/knockout-contrib/status.svg?path=packages/utils.increment
11 | [david-dm-peer]: https://david-dm.org/Profiscience/knockout-contrib?path=packages/utils.increment&type=peer
12 | [david-dm-peer-shield]: https://david-dm.org/Profiscience/knockout-contrib/peer-status.svg?path=packages/utils.increment
13 | [david-dm-dev]: https://david-dm.org/Profiscience/knockout-contrib?path=packages/utils.increment&type=dev
14 | [david-dm-dev-shield]: https://david-dm.org/Profiscience/knockout-contrib/dev-status.svg?path=packages/utils.increment
15 | [npm]: https://www.npmjs.com/package/@profiscience/knockout-contrib-utils-increment
16 | [npm-version-shield]: https://img.shields.io/npm/v/@profiscience/knockout-contrib-utils-increment.svg
17 | [npm-stats]: http://npm-stat.com/charts.html?package=@profiscience/knockout-contrib-utils-increment&author=&from=&to=
18 | [npm-stats-shield]: https://img.shields.io/npm/dt/@profiscience/knockout-contrib-utils-increment.svg?maxAge=2592000
19 |
20 | > This package is intended for consumption via the [@profiscience/knockout-contrib] metapackage.
21 |
22 | Increments/decrements a numeric observable. Returns the new value.
23 |
24 | ## Usage
25 |
26 | ```javascript
27 | import { increment, decrement } from '@profiscience/knockout-contrib'
28 |
29 | const foo = ko.observable(0)
30 |
31 | increment(foo) // 1
32 | increment(foo, 3) // 4
33 | decrement(foo) // 3
34 | decrement(foo, 2) // 1
35 | ```
36 |
--------------------------------------------------------------------------------
/packages/utils.increment/index.ts:
--------------------------------------------------------------------------------
1 | export function increment(
2 | obs: ko.Observable | ko.Computed,
3 | amt = 1
4 | ): number {
5 | const v = obs() + amt
6 | obs(v)
7 | return v
8 | }
9 |
10 | export function decrement(
11 | obs: ko.Observable | ko.Computed,
12 | amt = 1
13 | ): number {
14 | return increment(obs, -amt)
15 | }
16 |
--------------------------------------------------------------------------------
/packages/utils.increment/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@profiscience/knockout-contrib-utils-increment",
3 | "version": "2.0.1",
4 | "license": "WTFPL",
5 | "author": "Casey Webb (https://caseyWebb.xyz)",
6 | "homepage": "https://profiscience.github.io/knockout-contrib/packages/utils.increment",
7 | "bugs": "https://github.com/Profiscience/knockout-contrib/issues",
8 | "repository": "github:Profiscience/knockout-contrib",
9 | "publishConfig": {
10 | "access": "public"
11 | },
12 | "main": "dist/node/index.js",
13 | "module": "dist/default/index.js",
14 | "esnext": "dist/esnext/index.js",
15 | "types": "index.d.ts",
16 | "sideEffects": false,
17 | "peerDependencies": {
18 | "knockout": "3.5.1"
19 | },
20 | "dependencies": {
21 | "babel-runtime": "^6.26.0"
22 | }
23 | }
24 |
--------------------------------------------------------------------------------
/packages/utils.increment/test.ts:
--------------------------------------------------------------------------------
1 | import * as ko from 'knockout'
2 | import { increment, decrement } from './index'
3 |
4 | describe('utils.increment', () => {
5 | test('increment by 1 by default', () => {
6 | const count = ko.observable(0)
7 | increment(count)
8 | expect(count()).toBe(1)
9 | })
10 |
11 | test('increment by n', () => {
12 | const count = ko.observable(0)
13 | increment(count, 2)
14 | expect(count()).toBe(2)
15 | })
16 |
17 | test('increment writable computeds', (done) => {
18 | const count = ko.pureComputed({
19 | read: () => 0,
20 | write: (v) => {
21 | expect(v).toBe(1)
22 | done()
23 | },
24 | })
25 | increment(count)
26 | })
27 |
28 | test('increment throws with non writable computeds', () => {
29 | const count = ko.pureComputed(() => 0)
30 | expect(() => increment(count)).toThrow()
31 | })
32 |
33 | test('returns the new value', () => {
34 | const count = ko.observable(0)
35 | const v = increment(count)
36 | expect(v).toBe(count())
37 | })
38 | })
39 |
40 | describe('utils.decrement', () => {
41 | test('decrement by 1 by default', () => {
42 | const count = ko.observable(0)
43 | decrement(count)
44 | expect(count()).toBe(-1)
45 | })
46 |
47 | test('decrement by n', () => {
48 | const count = ko.observable(0)
49 | decrement(count, 2)
50 | expect(count()).toBe(-2)
51 | })
52 |
53 | test('decrement writable computeds', (done) => {
54 | const count = ko.pureComputed({
55 | read: () => 0,
56 | write: (v) => {
57 | expect(v).toBe(-1)
58 | done()
59 | },
60 | })
61 | decrement(count)
62 | })
63 |
64 | test('decrement throws with non writable computeds', () => {
65 | const count = ko.pureComputed(() => 0)
66 | expect(() => decrement(count)).toThrow()
67 | })
68 |
69 | test('returns the new value', () => {
70 | const count = ko.observable(0)
71 | const v = decrement(count)
72 | expect(v).toBe(count())
73 | })
74 | })
75 |
--------------------------------------------------------------------------------
/packages/utils.modify/README.md:
--------------------------------------------------------------------------------
1 | # utils.modify
2 |
3 | [![Version][npm-version-shield]][npm]
4 | [![Dependency Status][david-dm-shield]][david-dm]
5 | [![Peer Dependency Status][david-dm-peer-shield]][david-dm-peer]
6 | [![Dev Dependency Status][david-dm-dev-shield]][david-dm-dev]
7 | [![Downloads][npm-stats-shield]][npm-stats]
8 |
9 | [david-dm]: https://david-dm.org/Profiscience/knockout-contrib?path=packages/utils.modify
10 | [david-dm-shield]: https://david-dm.org/Profiscience/knockout-contrib/status.svg?path=packages/utils.modify
11 | [david-dm-peer]: https://david-dm.org/Profiscience/knockout-contrib?path=packages/utils.modify&type=peer
12 | [david-dm-peer-shield]: https://david-dm.org/Profiscience/knockout-contrib/peer-status.svg?path=packages/utils.modify
13 | [david-dm-dev]: https://david-dm.org/Profiscience/knockout-contrib?path=packages/utils.modify&type=dev
14 | [david-dm-dev-shield]: https://david-dm.org/Profiscience/knockout-contrib/dev-status.svg?path=packages/utils.modify
15 | [npm]: https://www.npmjs.com/package/@profiscience/knockout-contrib-utils-modify
16 | [npm-version-shield]: https://img.shields.io/npm/v/@profiscience/knockout-contrib-utils-modify.svg
17 | [npm-stats]: http://npm-stat.com/charts.html?package=@profiscience/knockout-contrib-utils-modify&author=&from=&to=
18 | [npm-stats-shield]: https://img.shields.io/npm/dt/@profiscience/knockout-contrib-utils-modify.svg?maxAge=2592000
19 |
20 | > This package is intended for consumption via the [@profiscience/knockout-contrib] metapackage
21 |
22 | Modifies an observable using a transform function. Returns the new value.
23 |
24 | Useful for wrapping general purpose utilities functions for Knockout observables.
25 |
26 | ## Usage
27 |
28 | ```javascript
29 | import { modify } from '@profiscience/knockout-contrib'
30 |
31 | const foobar = ko.observable('foobar')
32 |
33 | function reverseString(str) {
34 | return str.split('').reverse().join('')
35 | }
36 |
37 | const ret = modify(foobar, reverseString)
38 | ;(foobar() === ret) === 'raboof'
39 | ```
40 |
--------------------------------------------------------------------------------
/packages/utils.modify/index.ts:
--------------------------------------------------------------------------------
1 | export function modify(
2 | obs: ko.Observable | ko.Computed,
3 | fn: (v: T) => T
4 | ): T {
5 | const v = fn(obs())
6 | obs(v)
7 | return v
8 | }
9 |
--------------------------------------------------------------------------------
/packages/utils.modify/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@profiscience/knockout-contrib-utils-modify",
3 | "version": "2.0.1",
4 | "license": "WTFPL",
5 | "author": "Casey Webb (https://caseyWebb.xyz)",
6 | "homepage": "https://profiscience.github.io/knockout-contrib/packages/utils.modify",
7 | "bugs": "https://github.com/Profiscience/knockout-contrib/issues",
8 | "repository": "github:Profiscience/knockout-contrib",
9 | "publishConfig": {
10 | "access": "public"
11 | },
12 | "main": "dist/node/index.js",
13 | "module": "dist/default/index.js",
14 | "esnext": "dist/esnext/index.js",
15 | "types": "index.d.ts",
16 | "sideEffects": false,
17 | "peerDependencies": {
18 | "knockout": "3.5.1"
19 | },
20 | "dependencies": {
21 | "babel-runtime": "^6.26.0"
22 | }
23 | }
24 |
--------------------------------------------------------------------------------
/packages/utils.modify/test.ts:
--------------------------------------------------------------------------------
1 | import * as ko from 'knockout'
2 | import { modify } from './index'
3 |
4 | describe('utils.modify', () => {
5 | test('works with observables', () => {
6 | const str = ko.observable('foobar')
7 | modify(str, reverseString)
8 | expect(str()).toBe('raboof')
9 | })
10 | test('works with observable arrays', () => {
11 | const arr = ko.observableArray(['foo', 'bar'])
12 | modify(arr, (v) => v.reverse())
13 | expect(arr()).toEqual(['bar', 'foo'])
14 | })
15 | test('works with (writeable) computeds', () => {
16 | const _str = ko.observable('foobar')
17 | const str = ko.pureComputed({
18 | read: () => _str(),
19 | write: (v) => _str(v),
20 | })
21 | modify(str, reverseString)
22 | expect(str()).toBe('raboof')
23 | })
24 | test('returns the new value', () => {
25 | const foo = ko.observable('foo')
26 | expect(modify(foo, () => 'bar')).toBe('bar')
27 | })
28 | })
29 |
30 | function reverseString(str: string) {
31 | return str.split('').reverse().join('')
32 | }
33 |
--------------------------------------------------------------------------------
/packages/utils.once/README.md:
--------------------------------------------------------------------------------
1 | # utils.once
2 |
3 | [![Version][npm-version-shield]][npm]
4 | [![Dependency Status][david-dm-shield]][david-dm]
5 | [![Peer Dependency Status][david-dm-peer-shield]][david-dm-peer]
6 | [![Dev Dependency Status][david-dm-dev-shield]][david-dm-dev]
7 | [![Downloads][npm-stats-shield]][npm-stats]
8 |
9 | [david-dm]: https://david-dm.org/Profiscience/knockout-contrib?path=packages/utils.once
10 | [david-dm-shield]: https://david-dm.org/Profiscience/knockout-contrib/status.svg?path=packages/utils.once
11 | [david-dm-peer]: https://david-dm.org/Profiscience/knockout-contrib?path=packages/utils.once&type=peer
12 | [david-dm-peer-shield]: https://david-dm.org/Profiscience/knockout-contrib/peer-status.svg?path=packages/utils.once
13 | [david-dm-dev]: https://david-dm.org/Profiscience/knockout-contrib?path=packages/utils.once&type=dev
14 | [david-dm-dev-shield]: https://david-dm.org/Profiscience/knockout-contrib/dev-status.svg?path=packages/utils.once
15 | [npm]: https://www.npmjs.com/package/@profiscience/knockout-contrib-utils-once
16 | [npm-version-shield]: https://img.shields.io/npm/v/@profiscience/knockout-contrib-utils-once.svg
17 | [npm-stats]: http://npm-stat.com/charts.html?package=@profiscience/knockout-contrib-utils-once&author=&from=&to=
18 | [npm-stats-shield]: https://img.shields.io/npm/dt/@profiscience/knockout-contrib-utils-once.svg?maxAge=2592000
19 |
20 | > This package is intended for consumption via the [@profiscience/knockout-contrib] metapackage
21 |
22 | Creates a subscription that is called once and then disposed. Returns subscription for early disposal if necessary.
23 |
24 | ## Usage
25 |
26 | ```javascript
27 | import { once } from '@profiscience/knockout-contrib'
28 |
29 | const foo = ko.observable(0)
30 |
31 | const sub = once(foo, () => console.log('hit!'))
32 |
33 | foo(1)
34 | // hit!
35 |
36 | foo(2)
37 | // nothing...
38 | ```
39 |
--------------------------------------------------------------------------------
/packages/utils.once/index.ts:
--------------------------------------------------------------------------------
1 | export function once(
2 | obs: ko.Observable | ko.Computed,
3 | fn: (v: T) => void
4 | ): ko.Subscription {
5 | const killMe = obs.subscribe((v) => {
6 | killMe.dispose()
7 | fn(v)
8 | })
9 | return killMe
10 | }
11 |
--------------------------------------------------------------------------------
/packages/utils.once/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@profiscience/knockout-contrib-utils-once",
3 | "version": "2.0.1",
4 | "license": "WTFPL",
5 | "author": "Casey Webb (https://caseyWebb.xyz)",
6 | "homepage": "https://profiscience.github.io/knockout-contrib/packages/utils.once",
7 | "bugs": "https://github.com/Profiscience/knockout-contrib/issues",
8 | "repository": "github:Profiscience/knockout-contrib",
9 | "publishConfig": {
10 | "access": "public"
11 | },
12 | "main": "dist/node/index.js",
13 | "module": "dist/default/index.js",
14 | "esnext": "dist/esnext/index.js",
15 | "types": "index.d.ts",
16 | "sideEffects": false,
17 | "peerDependencies": {
18 | "knockout": "3.5.1"
19 | },
20 | "dependencies": {
21 | "babel-runtime": "^6.26.0"
22 | }
23 | }
24 |
--------------------------------------------------------------------------------
/packages/utils.once/test.ts:
--------------------------------------------------------------------------------
1 | import * as ko from 'knockout'
2 | import { once } from './index'
3 |
4 | test('subscribes once, then disposes', () => {
5 | expect.assertions(4)
6 |
7 | const observable = ko.observable('')
8 | const observableArray = ko.observableArray([])
9 | const computed = ko.computed(() => observable())
10 | const pureComputed = ko.pureComputed(() => observable())
11 |
12 | const hit = (v: any) => expect(v).toContain('foo')
13 |
14 | once(observable, hit)
15 | once(computed, hit)
16 | once(pureComputed, hit)
17 | once(observableArray, hit)
18 |
19 | observable('foo')
20 | observableArray(['foo'])
21 |
22 | // expect.assertions(4) would cause these to fail
23 | observable('bar')
24 | observableArray.push('bar')
25 | })
26 |
27 | test('returns the subscription', (done) => {
28 | expect.assertions(1)
29 |
30 | const observable = ko.observable('')
31 | const hit = jest.fn()
32 |
33 | const sub = once(observable, hit)
34 |
35 | sub.dispose()
36 |
37 | observable('foo')
38 |
39 | once(observable, () => {
40 | expect(hit).not.toBeCalled()
41 | done()
42 | })
43 |
44 | observable('bar')
45 | })
46 |
--------------------------------------------------------------------------------
/packages/utils.toggle/README.md:
--------------------------------------------------------------------------------
1 | # utils.toggle
2 |
3 | [![Version][npm-version-shield]][npm]
4 | [![Dependency Status][david-dm-shield]][david-dm]
5 | [![Peer Dependency Status][david-dm-peer-shield]][david-dm-peer]
6 | [![Dev Dependency Status][david-dm-dev-shield]][david-dm-dev]
7 | [![Downloads][npm-stats-shield]][npm-stats]
8 |
9 | [david-dm]: https://david-dm.org/Profiscience/knockout-contrib?path=packages/utils.toggle
10 | [david-dm-shield]: https://david-dm.org/Profiscience/knockout-contrib/status.svg?path=packages/utils.toggle
11 | [david-dm-peer]: https://david-dm.org/Profiscience/knockout-contrib?path=packages/utils.toggle&type=peer
12 | [david-dm-peer-shield]: https://david-dm.org/Profiscience/knockout-contrib/peer-status.svg?path=packages/utils.toggle
13 | [david-dm-dev]: https://david-dm.org/Profiscience/knockout-contrib?path=packages/utils.toggle&type=dev
14 | [david-dm-dev-shield]: https://david-dm.org/Profiscience/knockout-contrib/dev-status.svg?path=packages/utils.toggle
15 | [npm]: https://www.npmjs.com/package/@profiscience/knockout-contrib-utils-toggle
16 | [npm-version-shield]: https://img.shields.io/npm/v/@profiscience/knockout-contrib-utils-toggle.svg
17 | [npm-stats]: http://npm-stat.com/charts.html?package=@profiscience/knockout-contrib-utils-toggle&author=&from=&to=
18 | [npm-stats-shield]: https://img.shields.io/npm/dt/@profiscience/knockout-contrib-utils-toggle.svg?maxAge=2592000
19 |
20 | > This package is intended for consumption via the [@profiscience/knockout-contrib] metapackage
21 |
22 | Toggles a boolean observable
23 |
24 | ## Usage
25 |
26 | ```javascript
27 | import { toggle } from '@profiscience/knockout-contrib'
28 |
29 | const foo = ko.observable(true)
30 |
31 | toggle(foo) // false
32 | toggle(foo) // true
33 | ```
34 |
--------------------------------------------------------------------------------
/packages/utils.toggle/index.ts:
--------------------------------------------------------------------------------
1 | export function toggle(
2 | obs: ko.Observable | ko.Computed
3 | ): boolean {
4 | const orig = obs()
5 | const v = !orig
6 | if (typeof (orig as any) !== 'boolean') {
7 | throw new Error(
8 | `[@profiscience/knockout-contrib/utils.toggle]: Can only toggle boolean observables (type is ${typeof orig}`
9 | )
10 | }
11 | obs(v)
12 | return v
13 | }
14 |
--------------------------------------------------------------------------------
/packages/utils.toggle/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@profiscience/knockout-contrib-utils-toggle",
3 | "version": "2.0.1",
4 | "license": "WTFPL",
5 | "author": "Casey Webb (https://caseyWebb.xyz)",
6 | "homepage": "https://profiscience.github.io/knockout-contrib/packages/utils.toggle",
7 | "bugs": "https://github.com/Profiscience/knockout-contrib/issues",
8 | "repository": "github:Profiscience/knockout-contrib",
9 | "publishConfig": {
10 | "access": "public"
11 | },
12 | "main": "dist/node/index.js",
13 | "module": "dist/default/index.js",
14 | "esnext": "dist/esnext/index.js",
15 | "types": "index.d.ts",
16 | "sideEffects": false,
17 | "peerDependencies": {
18 | "knockout": "3.5.1"
19 | },
20 | "dependencies": {
21 | "babel-runtime": "^6.26.0"
22 | }
23 | }
24 |
--------------------------------------------------------------------------------
/packages/utils.toggle/test.ts:
--------------------------------------------------------------------------------
1 | import * as ko from 'knockout'
2 | import { toggle } from './index'
3 |
4 | describe('utils.toggle', () => {
5 | test('toggles boolean observable', () => {
6 | const bool = ko.observable(true)
7 | toggle(bool)
8 | expect(bool()).toBe(false)
9 | toggle(bool)
10 | expect(bool()).toBe(true)
11 | })
12 |
13 | test('toggles writable computeds', (done) => {
14 | const bool = ko.pureComputed({
15 | read: () => true,
16 | write: (v) => {
17 | expect(v).toBe(false)
18 | done()
19 | },
20 | })
21 | toggle(bool)
22 | })
23 |
24 | test('throws with non writable computeds', () => {
25 | const bool = ko.pureComputed(() => true)
26 | expect(() => toggle(bool)).toThrow()
27 | })
28 |
29 | test('throws with non booleans', () => {
30 | const num = ko.pureComputed(() => 0)
31 | expect(() => toggle(num as any)).toThrow()
32 | })
33 |
34 | test('returns the new value', () => {
35 | const bool = ko.observable(true)
36 | expect(toggle(bool)).toBe(false)
37 | })
38 | })
39 |
--------------------------------------------------------------------------------
/support/xvfb_entrypoint.sh:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | export DISPLAY=:99.0
4 |
5 | Xvfb :99 -screen 0 640x480x8 -nolisten tcp &
6 |
7 | exec "$@"
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "target": "es2017",
4 | "sourceMap": true,
5 | "jsx": "react",
6 | "jsxFactory": "h",
7 | "strict": true,
8 | "moduleResolution": "node",
9 | "allowSyntheticDefaultImports": true,
10 | "esModuleInterop": true,
11 | "noEmit": true,
12 | "noUnusedLocals": true,
13 | "lib": ["dom", "es5", "es2015", "esnext.asynciterable"]
14 | },
15 | "include": ["**/*"],
16 | "exclude": ["**/dist", "**/examples", "templates", "node_modules"]
17 | }
18 |
--------------------------------------------------------------------------------
/tslint.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": ["tslint:recommended", "tslint-config-prettier"],
3 | "rules": {
4 | "array-type": [true, "array"],
5 | "await-promise": true,
6 | "curly": [true, "ignore-same-line"],
7 | "deprecation": true,
8 | "interface-over-type-literal": false,
9 | "max-classes-per-file": false,
10 | "member-ordering": [true, "instance-sandwich"],
11 | "no-boolean-literal-compare": true,
12 | "no-floating-promises": true,
13 | "no-for-in-array": true,
14 | "no-unnecessary-qualifier": true,
15 | "object-literal-sort-keys": false,
16 | "ordered-imports": [false],
17 | "prefer-readonly": true,
18 | "restrict-plus-operands": true,
19 | "strict-type-predicates": true,
20 | "use-default-type-parameter": true,
21 | "variable-name": [
22 | true,
23 | "allow-leading-underscore",
24 | "allow-trailing-underscore"
25 | ]
26 | }
27 | }
28 |
--------------------------------------------------------------------------------