@armscye/container 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Augustus Kamau
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,17 @@
+# @armscye/container
+
+> A collection of shared standard TypeScript definitions.
+
+## Installation
+
+Using npm:
+
+```sh
+npm install --save-dev @armscye/container
+```
+
+or using yarn:
+
+```sh
+yarn add @armscye/container --dev
+```

package/dist/class-provider.interface.d.ts

@@ -0,0 +1,15 @@
+import { NoArgument } from '@armscye/core';
+import { ProviderToken } from './provider-token.interface';
+/**
+ * Configures the `Container` to return an instance of `useClass` for a token.
+ */
+export interface ClassProvider<T = any> {
+    /**
+     * Provider token.
+     */
+    provide: ProviderToken;
+    /**
+     * Class to instantiate for the `token`.
+     */
+    useClass: NoArgument<T>;
+}

package/dist/container.interface.d.ts

@@ -0,0 +1,20 @@
+import { ProviderToken } from './provider-token.interface';
+/**
+ * Describes the interface of a container that exposes methods to read its entries.
+ */
+export interface Container {
+    /**
+     * Find an entry of the container based on the provided token.
+     * @param token the provider token of the entry to look for
+     * @returns an entry from the container if defined
+     * @throws Error if no entry was found for the token
+     * @throws Error if error while retrieving the entry
+     */
+    get<T>(token: ProviderToken): T;
+    /**
+     * Check if an entry for the given provider token exists.
+     * @param token the provider token of the entry to look for
+     * @returns whether an entry for the given provider exists
+     */
+    has(token: ProviderToken): boolean;
+}

package/dist/existing-provider.interface.d.ts

@@ -0,0 +1,14 @@
+import { ProviderToken } from './provider-token.interface';
+/**
+ * Configures the `Container` to return a value of another `useExisting` token.
+ */
+export interface ExistingProvider<T = any> {
+    /**
+     * Provider token.
+     */
+    provide: ProviderToken;
+    /**
+     * Existing `token` to return.
+     */
+    useExisting: T;
+}

package/dist/factory-provider.interface.d.ts

@@ -0,0 +1,16 @@
+import { Factory } from './factory.interface';
+import { ProviderToken } from './provider-token.interface';
+/**
+ * Configures the `Container` to return a value by invoking a `useFactory` function.
+ */
+export interface FactoryProvider<T = any> {
+    /**
+     * Provider token.
+     */
+    provide: ProviderToken;
+    /**
+     * A function to invoke to create an instance for this `token`. The function is
+     * invoked with resolved values of token`s from an instance of the container.
+     */
+    useFactory: Factory<T>;
+}

package/dist/factory.interface.d.ts

@@ -0,0 +1,6 @@
+import { Container } from './container.interface';
+/**
+ * Represents type for a factory. A factory is a function that is able to create an object.
+ * It is provided with an instance of the container in order to access required dependencies.
+ */
+export type Factory<T = any> = (container: Container) => T;

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export * from './class-provider.interface';
+export * from './container.interface';
+export * from './existing-provider.interface';
+export * from './factory-provider.interface';
+export * from './factory.interface';
+export * from './provider-token.interface';
+export * from './provider.interface';
+export * from './value-provider.interface';

package/dist/provider-token.interface.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Token that can be used to retrieve an instance from a container.
+ */
+export type ProviderToken = string | symbol;

package/dist/provider.interface.d.ts

@@ -0,0 +1,5 @@
+import { ClassProvider } from './class-provider.interface';
+import { ExistingProvider } from './existing-provider.interface';
+import { FactoryProvider } from './factory-provider.interface';
+import { ValueProvider } from './value-provider.interface';
+export type Provider<T = any> = ValueProvider<T> | ClassProvider<T> | FactoryProvider<T> | ExistingProvider<T>;

package/dist/value-provider.interface.d.ts

@@ -0,0 +1,14 @@
+import { ProviderToken } from './provider-token.interface';
+/**
+ * Configures the `Container` to return a value for a token.
+ */
+export interface ValueProvider<T = any> {
+    /**
+     * Provider token.
+     */
+    provide: ProviderToken;
+    /**
+     * The value to inject.
+     */
+    useValue: T;
+}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@armscye/container",
+  "version": "0.1.0",
+  "description": "A collection of shared standard TypeScript definitions",
+  "author": "Augustus Kamau",
+  "license": "MIT",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "armscye",
+    "typescript",
+    "types"
+  ],
+  "dependencies": {
+    "@armscye/core": "^0.1.0"
+  },
+  "homepage": "https://github.com/armscye/armscye#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/armscye/armscye.git"
+  },
+  "bugs": {
+    "url": "https://github.com/armscye/armscye/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "052fa1099c964068feda456b787214c025533e6c"
+}