prici-io / prici Goto Github PK

They should be auto generated on pre-save

A developer wants to trigger increment state of feature, but instead of using http request - to trigger a redis message.

Prici should register to the redis event, in case a redis url was given as environment variable.

Architectural design needed before implementing this issue.

docs to express middleware usage

Currently, when creating a new Prici SDK instance in a NestJs app the app does not know about
the SDK instance in any way. This means that the SDK does not work in tandem with the Nest runtime.
By abstracting the SDK instance in a custom module, the following could be achieved:

• A simpler interface to work with.
• Less setup work.
• Less boilerplate code.
• Adding support for projects that use @nestjs/config
  and possibly other Nest related packages in the future.
• Passing default config options when instantiating
  the SDK in a central place and then using them all over the app.

• test sdk exists together with all its methods.
• test controller method.
• test kafka usage of increment.

scenario:

1. the plan is limited to X items, but any additional item will cost more.
2. state.isAllowed should be true in this case, but also have another property to mention the limit has reached (maybe state.hasReachedLimit).

The latest version of remult includes an Admin UI feature.

add the ability to turn the admin UI on using environment variable (ADMIN_UI=true)

right now, errorMessage is a require field in both express middleware and nest guard.
it should be optional, and if not exists - a default error message will appear.

let's say there's a user with multiple plans:

1. a monthly plan with 100 credits of some feature.
2. a "credits" plan with no-renewal.

when the user uses the feature, the increment should first come from the monthly package, and only when it's over - it should use the credits plan first.

same as when the user has multiple renewal plans - when it comes to a first plan limit - the counter should increment the second plan, and so on.

• test "get express middleware" function exists, both in js and ts.
• test that nest guard class exists, both in js and ts.
• test express middleware operation.
• test nest guard operation.

when coding:

 @Post("todos")
    @UseGuards(new IsAllowedGuard({
        // @ts-ignore
        sdk: priciSdk,
        errorMessage: "User is out of quota",
        getAccountId: (_) => "demo-account",
        getFieldId: (_) => featureId
    }))
    createTodo(@Body() body: any) {
        return this.appService.createTodo(body);
    }

without the ts-ignore - this code will never pass the build.
the error is:

TS2739: Type PriciSdk is missing the following properties from type PriciSdk: #remult, #accountFields

those are js private properties, and it's literally the same class, so it's weird that it's not passing.

Fields Groups should have a name and priority (for order).

a plan field should have a "group" property (optional) with a group id.

next issue to open after that PR will be merged:

getGroupState method - to validate an entire group.

Use Nuxt docs or vitepress.

First content:

• content from readme file.
• content from node sdk readme file

Provide a count API for a basic property.
Get the count for specific dates of that property.

That way users will be able to call an API call and charge by usage.

Assumption a Plan is composed of many properties which might be charged differently and dervied from different plans. The point is to do so by not knowing the whole plan's complexity - just the property.

the shared-remult and sdk packages should have links to thefull docs on prici.io

1. ability to get the state of multiple fields at the same request - by mentioning field ids.
2. ability to get all states of all account plan fields, including isAllowed calculated value.

A user would like to know anything that happened between/until/after certain dates.
A usage log entity can achieve this goal.

The usage log entity should persist:

• account id
• tenant
• field id (refer to the plan field)
• created at (date)
• usage: number
• additional info (string, optional)

The usage log should be set asynchronously on every increment action.
The usage property should be equal to the incementAmount given to the method (even if the field kind is boolean or string).

We should have an optional property to the increment method to support the additional info property, that will be stored in the usage log.
The user would like to add additional information about the increment action to add some context to the usage).

need to add:

1. what is the problem?
2. what is the proposed solution?
3. who is the target audience?

1. ability to reset the state to its original state.
2. ability to reset the state to the plan(s) current initial state (if edited afterwords).
3. ability to set new plans (replace) and reset the state to the current associated plan(s).

1. consider using native test operations of node.
2. should install most of the node backend frameworks as dev dependencies.

Currently, account plans have reset modes - monthly, yearly, and manually.

But sometimes, certain feature counters (for example - storage) shouldn't reset at the reset action.

this mission is to add a "resetMode" to the plan fields' entity and store it on the account plan state when its created.
the default is empty (undefined), so the reset mode of the field is the same as the account plan reset mode.

A developer wants to trigger an increment of a feature state - it should be able to push a message into a kafka topic.

Prici should register to this topic in case kafka arguments were given in environment variables.