Micha
Micha
PostsComments
CCConvex Community
Created by kstulgys on 1/3/2025 in #support-community
Ents is in maintenance mode. Should I use it?
Security (ABAC) - written in FSL I love their simple yet powerful ABAC system - in my opinion, the best part of Fauna, because it makes security relatively easy. 
role role_user {
  privileges User {
    read {
      predicate (doc => 
        doc == Query.identity()
      )
    }
    write {
      predicate ((oldDoc, newDoc) => {
        oldDoc.emails == newDoc.emails &&
        oldDoc.accounts == newDoc.accounts &&
        oldDoc == Query.identity()
      })
    }
  }

  privileges createOrganization {
    call {
      //A user can only be part of 5 organizations to prevent organization abuse. 
      // Limit can be lifted if you have a specific use case.
      predicate ((data) => { 
        Query.identity()!.organizations == null || Query.identity()!.organizations.length < 5 
      })
    }
  }


  membership User {
    predicate ( (doc) => isCalledWithAccessToken() )
  }
}
role role_user {
  privileges User {
    read {
      predicate (doc => 
        doc == Query.identity()
      )
    }
    write {
      predicate ((oldDoc, newDoc) => {
        oldDoc.emails == newDoc.emails &&
        oldDoc.accounts == newDoc.accounts &&
        oldDoc == Query.identity()
      })
    }
  }

  privileges createOrganization {
    call {
      //A user can only be part of 5 organizations to prevent organization abuse. 
      // Limit can be lifted if you have a specific use case.
      predicate ((data) => { 
        Query.identity()!.organizations == null || Query.identity()!.organizations.length < 5 
      })
    }
  }


  membership User {
    predicate ( (doc) => isCalledWithAccessToken() )
  }
}
14 replies
CCConvex Community
Created by kstulgys on 1/3/2025 in #support-community
Ents is in maintenance mode. Should I use it?
They had GraphQL support, but they dropped it in favor of their more powerful FQL language, which is inspired by JavaScript, Python, and GraphQL. Collections (Table) Written in a language file called fsl (fauna schema language). I appreciated the co-location of collection constraints, making it easy to understand a collection and its associated rules. 
collection User {
    firstName: String
    ...
    compute emailVerification: String? = doc => { getVerificationEmail(doc.id)} // A field that will be resolved while fetching

    compute roles: Array<String> = (user => currentRoles()) 
    activeOrganization: Ref<Organization>?
    organizations: Array<Ref<Organization>>?

    // A check constraint ensures the created/updated/replaced data comply a specific shape
    check isActiveOrganizationPartOfOrganizations ((user) => {
        if(user.activeOrganization != null) {
            user.organizations?.includes(user.activeOrganization)
        } else {
            true
        }
    })

    check uniqueEmails (user => user.emails.length == user.emails.distinct().length)
    unique [mva(.emails)]
    check uniqueAccounts (user => user.accounts.length == user.accounts.distinct().length)
    unique [mva(.accounts)]
}
collection User {
    firstName: String
    ...
    compute emailVerification: String? = doc => { getVerificationEmail(doc.id)} // A field that will be resolved while fetching

    compute roles: Array<String> = (user => currentRoles()) 
    activeOrganization: Ref<Organization>?
    organizations: Array<Ref<Organization>>?

    // A check constraint ensures the created/updated/replaced data comply a specific shape
    check isActiveOrganizationPartOfOrganizations ((user) => {
        if(user.activeOrganization != null) {
            user.organizations?.includes(user.activeOrganization)
        } else {
            true
        }
    })

    check uniqueEmails (user => user.emails.length == user.emails.distinct().length)
    unique [mva(.emails)]
    check uniqueAccounts (user => user.accounts.length == user.accounts.distinct().length)
    unique [mva(.accounts)]
}
CRUD (Written in FQL - Fauna query language) I liked the short, but powerful syntax. 
// Read
User.byId("123")
User.all()
User.first()

// They make it amazingly easy to filter based on or retrieve related ents
User.all().where((user) => user.activeOrganization.plan == "Pro")
User.first().activeOrganization

// Create
User.create({
  firstName: "John"
})

// Delete
User.byId("123").delete()

// Update & Replace
User.byId("123").update({})
User.byId("123").replace({})

// Projection 
User.first() {
  firstName,
  lastName,
  primaryEmail
}
// Read
User.byId("123")
User.all()
User.first()

// They make it amazingly easy to filter based on or retrieve related ents
User.all().where((user) => user.activeOrganization.plan == "Pro")
User.first().activeOrganization

// Create
User.create({
  firstName: "John"
})

// Delete
User.byId("123").delete()

// Update & Replace
User.byId("123").update({})
User.byId("123").replace({})

// Projection 
User.first() {
  firstName,
  lastName,
  primaryEmail
}
More queries: https://docs.fauna.com/fauna/current/reference/fql-api/cheat-sheet/
14 replies
CCConvex Community
Created by kstulgys on 1/3/2025 in #support-community
Ents is in maintenance mode. Should I use it?
Thanks for sharing—I will check it. The second article about SQL is probably not so relevant to me as I come from Fauna (their service is ending at the end of May—eventually, this is an opportunity for you to get more Fauna customers a new home 😉 ).
14 replies
CCConvex Community
Created by kstulgys on 1/3/2025 in #support-community
Ents is in maintenance mode. Should I use it?
Does that mean if I go now with Ents, I can expect some relevant migration later if you ship your own version as part of the convex core?
14 replies
Aarktype
Created by Micha on 3/3/2025 in #questions
How to create an arktype generic from a generic class<>?
Alternatively I have created page now manually as an arktype: 
export const page = <T extends QueryValue>(of: type.Any<T>) =>
  type({
    data: [of, "[]"],
    "after?": "string",
  });
export const page = <T extends QueryValue>(of: type.Any<T>) =>
  type({
    data: [of, "[]"],
    "after?": "string",
  });
but then I wonder how I can use it as part of a scope: 
import { page } from from "./system";

const types = scope({
  organization: {
    invitations: page("invitation"), // This is not working as "invitation" is nor more recognized as arktype
    // invitations: page(type("invitation")), // This is not working as type is not more part of scope
    // invitations: ["page(", "invitation", ")"], // This is also not working because it's obviously breaking javascript.
  },
  invitation: {
      email: "string",
  },
}).export();
import { page } from from "./system";

const types = scope({
  organization: {
    invitations: page("invitation"), // This is not working as "invitation" is nor more recognized as arktype
    // invitations: page(type("invitation")), // This is not working as type is not more part of scope
    // invitations: ["page(", "invitation", ")"], // This is also not working because it's obviously breaking javascript.
  },
  invitation: {
      email: "string",
  },
}).export();
Can I solve that somehow with submodules? This is currently a bit over my head 🙈
2 replies
Aarktype
Created by san on 3/2/2025 in #questions
array of objects?
const arrays = type({
    key: type({ name: "string" }, "[]")
})
const arrays = type({
    key: type({ name: "string" }, "[]")
})
https://arktype.io/docs/objects#arrays
6 replies
Aarktype
Created by Micha on 2/24/2025 in #questions
avatar must be a string (was undefined) although undefined it expected type
Workaround: Adding the "undefined" keyword explicitly. 
export const profileData = type({
    firstName: 'string',
    lastName: 'string',
    'avatar?': 'string | undefined'
});
export const profileData = type({
    firstName: 'string',
    lastName: 'string',
    'avatar?': 'string | undefined'
});
https://arktype.io/docs/primitives#undefined But this limits the usage of .partial(). So, if there would be a way that .partial() can do this automatically, this would be awesome.
10 replies
Aarktype
Created by Micha on 2/5/2025 in #questions
Why is the generic expecting 3 options, although there is only one generic prop?
Got it - subscribed to the issue - thaaanks 🙂
5 replies
Aarktype
Created by Micha on 2/4/2025 in #questions
scope() how to bypass circular reference error?
I think I go for now with this one: 
const types = type
  .scope({
    queryValue: "namedDocument<Record<string, unknown>>",
    queryValueObject: {
      "[string]": "queryValue",
    },

    "namedDocument<metadata extends Record<string, unknown>>": {
      "data?": "metadata",
    },
  })
  .export();
const types = type
  .scope({
    queryValue: "namedDocument<Record<string, unknown>>",
    queryValueObject: {
      "[string]": "queryValue",
    },

    "namedDocument<metadata extends Record<string, unknown>>": {
      "data?": "metadata",
    },
  })
  .export();
14 replies
Aarktype
Created by Micha on 2/4/2025 in #questions
scope() how to bypass circular reference error?
Sound like you should consider writing your own compiler to get beyond such problems 😛
14 replies
Aarktype
Created by Micha on 2/4/2025 in #questions
scope() how to bypass circular reference error?
Do you think this is solvable, and should I create a GitHub issue, or is it a general limitation?
14 replies
Aarktype
Created by Micha on 2/4/2025 in #questions
scope() how to bypass circular reference error?
This is the working equivalent in typescript: 
type QueryValue = NamedDocument
type QueryValueObject = {
    [key: string]: QueryValue
}

type NamedDocument<metadata extends QueryValueObject = Record<string, never>> = {
    data?: metadata
}
type QueryValue = NamedDocument
type QueryValueObject = {
    [key: string]: QueryValue
}

type NamedDocument<metadata extends QueryValueObject = Record<string, never>> = {
    data?: metadata
}
14 replies
Aarktype
Created by Micha on 2/4/2025 in #questions
How to integrate generics with extend that need to access a type in scope?
I have to say I'm quite impressed with how far I have already come without a painful workaround (I say only cyclic references + zod... 😉 ). You did here definitely an outstanding job 👍
15 replies
Aarktype
Created by Micha on 2/4/2025 in #questions
How to integrate generics with extend that need to access a type in scope?
awesome - that is what I need. My goal was to group the types logically to keep it a bit tidy 🙂
15 replies
Aarktype
Created by Micha on 2/4/2025 in #questions
How to integrate generics with extend that need to access a type in scope?
The way you phrase it, sounds like it's a limitation?
15 replies
Aarktype
Created by Micha on 2/4/2025 in #questions
How to integrate generics with extend that need to access a type in scope?
I've updated it, but I'm still getting an error that metadata is unresolvable Type '"metadata"' is not assignable to type '"'metadata' is unresolvable "'.ts(2322): 
scope({
  queryValue: [
    "null | string | number | bigint | boolean | queryValueObject | queryValue[]",
    uint8Array,
    dateStub,
    timeStub,
    module,
  ],
  queryValueObject: {
    "[string]": "queryValue",
  },
  namedDocument: {
    "read<metadata extends queryValueObject>": {
      coll: module,
      name: "string",
      ts: timeStub,
      "data?": "metadata",
    }
  },
}).export();
scope({
  queryValue: [
    "null | string | number | bigint | boolean | queryValueObject | queryValue[]",
    uint8Array,
    dateStub,
    timeStub,
    module,
  ],
  queryValueObject: {
    "[string]": "queryValue",
  },
  namedDocument: {
    "read<metadata extends queryValueObject>": {
      coll: module,
      name: "string",
      ts: timeStub,
      "data?": "metadata",
    }
  },
}).export();
If I'm renaming "metadata" to "t" the error changes to Type '"t"' is not assignable to type '"true"'.ts(2322) 
"read<t extends queryValueObject>": {
      coll: module,
      name: "string",
      ts: timeStub,
      "data?": "t",
    }
"read<t extends queryValueObject>": {
      coll: module,
      name: "string",
      ts: timeStub,
      "data?": "t",
    }
15 replies
Aarktype
Created by Micha on 2/4/2025 in #questions
How to integrate generics with extend that need to access a type in scope?
oh, somehow I missed this part in the docs, although I have read over this today probably already 10 times 😬
15 replies